Clean Architecture Workouts API

This Node.js application provides an API for managing workouts. It follows the clean architecture principles introduced by Bob Martin and serves as a demonstration of how to implement such architecture in a Node.js project.

Prerequisites

Before running this project, ensure you have the following installed:

• Node.js: Ensure you have Node.js installed.
• MongoDB: Use MongoDB Atlas or install and run MongoDB locally.

Installation

1. Clone the repo and install dependencies:

   git clone https://github.com/ruth-cohen89clean-arch-workouts-api.git
   cd clean-arch-workouts-api
   npm install

Configuration

1. Create a .env file: Create a .env file in the root directory of the project.

2. Define the NODE_ENV variable: In the .env file, set the NODE_ENV variable to either development or production. For example:

   NODE_ENV=development
   

   This environment variable controls the application's runtime environment.

3. Set up MongoDB connection: Replace your-database-name with your MongoDB database name and your-database-password with your MongoDB database password in the .env file. Make sure to replace your-database-name and your-database-password with your actual MongoDB database name and password, respectively.

   DATABASE=your-database-name
   DATABASE_PASSWORD=your-database-password
   

Usage

1. Start the server:

   npm start
   

2. Access the API endpoints using a tool like curl, Postman, or integrate it into your frontend application.

Project Structure

The project follows the clean architecture principles proposed by Bob Martin. Here's a brief overview of the project structure:

• src/: Contains the application source code.
  • controllers/: Controllers responsible for handling HTTP requests and responses.
  • middlewares/: Middleware functions.
  • models/: Data models representing domain entities.
  • routes/: Route definitions for mapping endpoints to controller actions.
  • services/: Business logic and application services.
  • utils/: Utility functions and helpers.
• config/: Configuration files.
• app.js: Entry point of the application.
• .env: Environment variables.

Contributing

Contributions are welcome! If you have suggestions for improvements, or if you encounter any issues, feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License.