This is a project that implements a store management system using Node.js.
The project utilizes the following technologies:
- Node.js
- Express
- MySQL
- Sequelize
- JWT (JSON Web Tokens)
- BCrypt
Before you begin, ensure that you meet the following requirements:
- Have Node.js installed: Node.js Downloads.
- Have MySQL installed and running.
Follow these steps to set up and run the project locally:
- Clone the repository:
- Navigate to the project directory:
- Install the dependencies:
- Create a `.env` file based on the provided `.env.example` file, and update the environment variables with your MySQL connection details.
- Run the database migrations:
- Start the server:
- Access the API endpoints using a tool like Postman or cURL.
git clone https://github.com/BrunoSouza88/NodeJS-MSC_Store-Manager_Trybe.git
cd NodeJS-MSC_Store-Manager_Trybe
npm install
npx sequelize db:migrate
npm start
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.
Contributions are what make the open-source community a fantastic place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the project.
- Create a branch for your feature (
git checkout -b feature/AmazingFeature
). - Commit your changes (
git commit -m 'Add some amazing feature'
). - Push to the branch (
git push origin feature/AmazingFeature
). - Open a Pull Request.
This project is licensed under the MIT License.
Bruno Souza - bmsouza88@gmail.com
Project Link: https://github.com/BrunoSouza88/NodeJS-MSC_Store-Manager_Trybe