Landienzla/voco-task

Postman API Doc

Getting Started

1. Clone the Repository

   git clone https://github.com/Landienzla/voco-task.git
   cd voco-task

2. Create and Fill the .env File
3. Install Dependencies

   npm install

4. Set up MONGODB Database

   Make sure you have MONGODB installed and running. Update the database connection details in the configuration file.

5. Start the Development Server

   npm run develop

6. Build and Run the Application
   1. Build the application by running:

      npm run build

   2. Start the application in production mode using:

      npm run start:prod

Your application should now be running at http://localhost:3001.

Directory Structure

Briefly describe the layout of your project, e.g.,

• src/: All the TypeScript server code resides here.
  • routes/: Contains Express route definitions for the various API endpoints.
  • controllers/: Houses the logic for handling requests and responses for each route. Controllers are responsible for interfacing between the API routes and the database models.
  • middlewares/: Includes middleware functions used across the application. Middlewares are used for tasks like request processing, authentication, error handling, and other common functions that are executed during the HTTP request-response cycle.
  • utils/: Utility functions that provide common functionalities used throughout the application, such as helper functions, data formatting, and other shared logic.