README.md

You can try out a demo of the API here.

To access the demo, use /auth/login with the following credentials:

{
  "username": "admin",
  "password": "ABC#abc#123"
}

{
  "username": "client_1",
  "password": "ABC#abc#123"
}

You can use the Swagger Bearer authentication by clicking Authorize to enter the token generated from the /auth/login endpoint. Once you have authenticated with the token, you can automatically test all endpoints that the user has access to.

1. Install Node.js, Git, and Npm:

   Download and install Node.js (preferably version 22 to ensure compatibility) from the official website: https://nodejs.org/en. Verify the installation by running:

   node --version
   

   Download and install Git from the official website: https://git-scm.com. Verify the installation by running:

   git --version
   

   Npm is installed automatically with Node.js. Verify the installation by running:

   npm --version
   

2. Clone the project and switch to the develop branch:

   Run the following commands to clone the repository and checkout the develop branch:

   git clone https://https://github.com/cerciber/nest-general-architecture.git
   cd nest-general-architecture
   git checkout develop
   

3. Install dependencies:

   Run the following command to install all project dependencies:

   npm install
   

4. Create configuration file:

   Create a file named .env.development in the root of the project with the following content:

   # PORT: Port number on which the application will listen for incoming requests
   PORT=
   # MONGO_URI: Connection string for MongoDB. Includes the database server address, port, and authentication details if required.
   MONGO_URI=
   # JWT_SECRET_KEY: Key used for signing and verifying JSON Web Tokens (JWTs). Ensure this key is strong, unique, and kept confidential.
   JWT_SECRET_KEY=
   

5. Create sample data (Only if you want to use your own database):

   If you need reset database and set sample data, you can easily do so by running the following command:

   npm run db:reset
   

6. Install VSC extensions (Optional for Visual Studio Code) :

   You can install the required VS Code extensions by running the following commands:

   code --install-extension dbaeumer.vscode-eslint
   code --install-extension rvest.vs-code-prettier-eslint
   

   Alternatively, you can install these extensions Prettier ESlint and ESlint manually from the VS Code marketplace.

   To ensure that the configurations are applied correctly, restart Visual Studio Code.

   
   

7. Run the project in development mode:

   Navigate to the project directory and run the following command to start the project in development mode:

   npm run start:dev
   

   This will start the project with the development configuration.

   You can view the documentation at http://localhost:<PORT>/docs, where <PORT> is the port specified in your .env.development file.