Skip to content

Latest commit

 

History

History
90 lines (60 loc) · 2.5 KB

README.md

File metadata and controls

90 lines (60 loc) · 2.5 KB

E-commerce backend

badge

Description

A MySQL database and application backend for an e-commerce site, where users are able to interact and manipulate data: they can create, update, delete or view desired products, tags and categories. Powered with MySQL2, Express, Sequelize and Dotenv.

Demo

Demo Video

Link to video

Table of Contents

Installation

Clone this repository on your local machine:

$ git clone https://github.com/lukecp5/e-commerce-backend.git
$ cd e-commerce-backend

To install and set up the application, run:

$ npm install employee-tracker

You will also need to place a .env file in the root directory of the project, in order to connect to your MySQL database.

file: .env

DB_NAME = employee_db
DB_PASSWORD = 'Your MySQL Password'
DB_USER = 'root'

Usage

After installation is complete and .env file created in root directory, complete the following steps:

  1. Create a MySQL database on your local machine using the schema.sql file located in the /db/ directory (From the MySQL CLI, write 'SOURCE db/schema.sql;')
  2. Seed the database with sample data to be used for testing purposes(Run npm run seed from inside the root directory of the project)

Now you're ready to start the application! You can start the server by running:

npm start

License

The application is covered under the following license: ISC

Contributing

For the moment this project does not accept contributions from third parties. Thank you for your interest.

Technologies

This application was built with:

  • Node.js
  • Sequelize
  • Express.js
  • MySQL2
  • Dotenv

Questions

Please feel free to contact me using the following links: