Skip to content

BrunoSouza88/NodeJS-MSC_Store-Manager_Trybe

Repository files navigation

Store-Manager

This is a project that implements a store management system using Node.js.

Technologies Used

The project utilizes the following technologies:

  • Node.js
  • Express
  • MySQL
  • Sequelize
  • JWT (JSON Web Tokens)
  • BCrypt

Prerequisites

Before you begin, ensure that you meet the following requirements:

Installation

Follow these steps to set up and run the project locally:

  1. Clone the repository:
  2. git clone https://github.com/BrunoSouza88/NodeJS-MSC_Store-Manager_Trybe.git
  3. Navigate to the project directory:
  4. cd NodeJS-MSC_Store-Manager_Trybe
  5. Install the dependencies:
  6. npm install
  7. Create a `.env` file based on the provided `.env.example` file, and update the environment variables with your MySQL connection details.
  8. Run the database migrations:
  9. npx sequelize db:migrate
  10. Start the server:
  11. npm start
  12. Access the API endpoints using a tool like Postman or cURL.

Usage

The API provides various endpoints for managing the store's products, categories, and sales. Users can perform CRUD operations, authenticate with JWT, and access protected routes.

Contributing

Contributions are what make the open-source community a fantastic place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the project.
  2. Create a branch for your feature (git checkout -b feature/AmazingFeature).
  3. Commit your changes (git commit -m 'Add some amazing feature').
  4. Push to the branch (git push origin feature/AmazingFeature).
  5. Open a Pull Request.

License

This project is licensed under the MIT License.

Contact

Bruno Souza - bmsouza88@gmail.com

Project Link: https://github.com/BrunoSouza88/NodeJS-MSC_Store-Manager_Trybe