@sundaysf/cli v0.1.8

Sundays Framework Backend Setup

Welcome to the Sundays Framework for backend development! This project is part of the Sundays development methodology, which focuses on scalable, efficient, and easy-to-maintain backend applications. The framework streamlines development, allowing you to focus on features instead of boilerplate code.

Installation

To install the Sundays Framework and initialize the backend, run the following command:

npx @sundaysf/cli --init --backend

This will install the necessary dependencies and set up the project structure tailored for backend development.

Creating a Controller

To add a controller with essential CRUD operations (including GET, GET By UUID, UPDATE, DELETE, and CREATE), run the following command:

npm run create:controller

You will be prompted to provide a name for your new controller. Once created, the controller will include all the necessary routes and methods.

Development Setup

For development, use the following commands:

• Start Development Server:
  Runs the backend with nodemon for auto-reloading during development:

npm run start:dev

• Build Project:
  Transpiles the TypeScript code to JavaScript (or your chosen transpiler):

npm run build

• Start Production Server:
  Runs the backend in production mode:

npm run start

Docker Support

The project comes with a Dockerfile to help you quickly set up the environment using Docker. You can build and run the project within a container for easy deployment.

To build the Docker image:

docker build -t your-image-name .

To run the container:

docker run -p 3098:3098 your-image-name

This will run the application inside a Docker container, making it easy to deploy or share across different environments.