πDescription
Developed a back-end for an e-commerce site. Using an Express.js API and a Sequelize database, configure the API so that it interacts with the database using Sequelize.
- Description
- Submission
- User Story
- Acceptance Criteria
- Mock-Up
- Installation
- License
- Contributing
- FAQs
π Submission
Github Page: https://github.com/VimukthiGunasekara/e-commerce-back-end
π€ User Story
AS A manager at an internet retail company
I WANT a back end for my e-commerce website that uses the latest technologies
SO THAT my company can compete with other e-commerce companies
π Acceptance Criteria
GIVEN a functional Express.js API
WHEN I add my database name, MySQL username, and MySQL password to an environment variable file
THEN I am able to connect to a database using Sequelize
WHEN I enter schema and seed commands
THEN a development database is created and is seeded with test data
WHEN I enter the command to invoke the application
THEN my server is started and the Sequelize models are synced to the MySQL database
WHEN I open API GET routes in Insomnia for categories, products, or tags
THEN the data for each of these routes is displayed in a formatted JSON
WHEN I test API POST, PUT, and DELETE routes in Insomnia
THEN I am able to successfully create, update, and delete data in my database
πΊ Mock-Up
βοΈ Installation
Use your terminal to clone or download or copy the zip file to a directory of your choice. Then open the file in VS Code or whatever editor you use. In VS Code, open the terminal and navigate to e-commerce-back-end in the root directory.
npm init
npm install mysql2
npm install sequelize
npm install dotenv
Run the following command at the root of your project and answer the prompted questions:
mysql -u root -p
Enter PW when promted
source db/schema.sql
quit
npm run seed
npm start
π License
Your repository is licensed under an mit open source license, so other people can contribute more easily.More information can be found by clicking this link.
π€ Contributing
We are open to all kinds of contributions. If you want to:
- π€ Suggest a feature
- π Report an issue
- π Improve documentation
- π¨βπ» Contribute to the code
We are excited that you are reading this and are willing to contribute. No need to think big. Even a typo fix might save our day and make you a hero. Every contribution counts!
Feel free to check issues page
π€ FAQs
Please contact me using the following links:
GitHub / Email: [email protected]