MyBrand-BE

Welcome to MyBrand-BE! This repository contains the full backend project built with Node.js, Express.js, MongoDB, CircleCI, Swagger, and Jest for testing. MyBrand-BE focuses on providing a robust backend infrastructure for a web application.

Features

• Express.js: Utilizes the powerful Express.js framework for handling HTTP requests, routing, and middleware.
• MongoDB: Integrates MongoDB for data storage, providing flexibility and scalability for handling various types of data.
• CircleCI: Implements Continuous Integration/Continuous Deployment (CI/CD) with CircleCI to automate the testing and deployment process.
• Swagger: Generates API documentation using Swagger, making it easy to understand and consume the backend APIs.
• Jest: Implements unit and integration tests using Jest, ensuring the reliability and correctness of the backend code.
• Other Packages: Utilizes various npm packages for authentication, validation, logging, and other functionalities.

Getting Started

1. Clone the Repository: Clone this repository to your local machine using the following command:
   git clone https://github.com/munezeromicha/MyBrand-BE.git
2. Install Dependencies: Navigate to the project directory and install the dependencies using npm or yarn:
   cd MyBrand-BE
npm install
3. Set Up Environment Variables: Create a .env file in the root directory of the project and configure the environment variables required for the project.
4. Start the Server: Start the backend server using the following command:
   npm start
5. Explore APIs: Access the Swagger documentation to explore and test the backend APIs. Open your browser and navigate to http://localhost:9000/api-docs.

Testing

MyBrand-BE includes a comprehensive test suite to ensure the reliability and correctness of the backend code. To run the tests, use the following command:

npm test

Contributing

Contributions are welcome! If you have any suggestions, improvements, or bug fixes, feel free to open an issue or submit a pull request.

License

Contact

If you have any questions or need further assistance, feel free to contact the project maintainer:

• Email: My email
• GitHub: Github Link