Skip to content

EhsanAsh/e-commerce-backend

Repository files navigation

E-commerce Backend Application

E@sh

GitHub license License: MIT License

Visual Studio Code JavaScript NodeJS MySQL Git Markdown Nodemon Sequelize ESLint


Description

The E-commerce Backend Application is a Node.js based application designed for internet retail company managers who wish to have a powerful back end for their e-commerce website with the latest technologies. This application allows you to seamlessly connect to a MySQL database using Sequelize, perform schema and seed operations to create and populate a development database with test data, and invoke the application, syncing Sequelize models to the MySQL database. With functional API routes for categories, products, and tags, managers can easily test and manipulate their database content, ensuring their e-commerce platforms are competitive and efficient.


Table of Contents


Installation

To install the E-commerce Backend Application, follow these steps:

  1. Clone the repository to your local machine.
  2. Navigate to the root directory of the project in your terminal.
  3. Install the required node packages by running npm install.
  4. Set up your environment variables in a .env file in the root, providing your database name, MySQL username, and MySQL password.
  5. Once installations are complete, the application is ready for use.

Usage

To use the E-commerce Backend Application:

  1. Navigate to the root directory of the project in your terminal.
  2. Run schema and seed commands to set up your database.
  3. Invoke the application and start your server.
  4. Open API routes in Insomnia Core for testing and interacting with your database.

Demo

Demo Link


Credits

This project utilizes the following libraries and packages:

  • dotenv for environment variable management.
  • express to build the server and API routes.
  • mysql2 and mysql for connecting to the MySQL database.
  • sequelize for database interaction and model definition.
  • eslint for code linting and formatting.

License

This project is licensed under the MIT license.


Features

  • Efficient connection to a MySQL database using Sequelize.
  • Functional API GET, POST, PUT, and DELETE routes for categories, products, and tags.
  • Application invocation that syncs Sequelize models to the MySQL database.
  • Formatted JSON data display for all API routes.

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check issues page.


Test

The application’s functionality meets the outlined acceptance criteria and has been tested manually.


Questions

Please visit my GitHub profile: GitHub If you have any questions regarding this Application, please email me at: Email Me

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published