Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aniraannu/e-commerce-back-end


https://github.com/aniraannu/e-commerce-back-end

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README 

        
# E-Commerce Back-end



Internet retail, also known as **e-commerce**, plays a significant role within the electronics industry, as it empowers businesses and consumers alike to conveniently engage in online buying and selling of electronic products. In the latest available data from 2021, the industry in the United States alone was estimated to have generated the substantial amount of US$2.54 trillion, according to the United Nations Conference on Trade and Development. E-commerce platforms like Shopify and WooCommerce provide a suite of services to businesses of all sizes. Due to the prevalence of these platforms, developers should understand the fundamental architecture of e-commerce sites.



This project is to build the back end for an e-commerce site by modifying starter code. You’ll configure a working Express.js API to use Sequelize to interact with a PostgreSQL database.



## Description



This repo contains the back-end code to manage an e-commerce site. The main objective of this project is to use Object-Relational Mapping, which allows us to convert data between incompatible systems using object-oriented programming. ORM libraries, such as Sequelize, allow us to make calls to the database without having to write SQL queries, and can instead use Javascript. This project uses node.js, npm, express.js, sequelize, postgreSQL, and dotenv packages. There is no front-end for this app, therefore all interactions with the app go through Insomnia. The walk-through video below demonstrates the apps functionality.



## Getting Started



If you'd like to see a full demo of the application, please visit the following link: Demo Video on Google Drive

https://drive.google.com/file/d/1asPV9N_UikeoguPxo5CoGGvvnzNnADz4/view?usp=sharing



All the routes and it's testing in the insomnia is included in this video: https://drive.google.com/file/d/1zVpwNcD8mTwjWmNvZ4XKXLTJlyfq_40j/view?usp=sharing



The following animation shows the application's GET routes to return all categories, all products, and all tags being tested in Insomnia:



![In Insomnia, the user tests “GET tags,” “GET Categories,” and “GET All Products.”.](./Assets/13-orm-homework-demo-01.gif)



The following animation shows the application's GET routes to return a single category, a single product, and a single tag being tested in Insomnia:



![In Insomnia, the user tests “GET tag by id,” “GET Category by ID,” and “GET One Product.”](./Assets/13-orm-homework-demo-02.gif)



The following animation shows the application's POST, PUT, and DELETE routes for categories being tested in Insomnia:



![In Insomnia, the user tests “DELETE Category by ID,” “CREATE Category,” and “UPDATE Category.”](./Assets/13-orm-homework-demo-03.gif)



### Dependencies



- express 4.17.1

- dotenv 8.2.0

- pg 8.11.3

- sequelize 5.21.7



### Installing



- Clone the repo: git clone https://github.com/aniraannu/SVG-logo-maker



- Open in VS Code. If you do not have VS code you must install it.



- Using the terminal, install node.js v16. If you have homebrew, the command should look like the following (brew install node@16), however this may vary and the documentation should be consulted.



- Once node.js v16 is installed, in the terminal, utilize the command npm init -y to initialize and create a package.json where project files will be stored.



- Next, use the terminal to run the command npm i to install the dependencies associated with this application (developers may need to install inquirer and jest directly from the command line, to do so the command for inquirer will be npm i [email protected] to install v8.2.4 of the inquirer, and npm i jest to install the latest version of jest).



- Start the Server, Sync the Sequelize models to the PostgreSQL database.



- User will need to use the PostgreSQL and Sequelize packages to connect your Express.js API to a PostgreSQL database and the dotenv package to use environment variables to store sensitive data.



- Use the schema.sql file in the db folder to create the database with PostgresSQL shell commands.



- Use environment variables to store sensitive data such as: PostgreSQL username, password, and database name.



- Run npm run seed to seed data to the database to test the routes.



### Executing program



- The application code can be cloned from the following Github link:

  [GitHub-E-Commerce-back-end](https://github.com/aniraannu/E-Commerce-back-end)



## Help



NA



## Authors



Contributors names and contact info



Anira Raveendran

[@aniraannu](https://github.com/aniraannu)



## Version History



- 0.1

  - Initial Release



## License



None



## Acknowledgments



Inspiration, code snippets, etc.



- [dbader](https://github.com/dbader/readme-template)

- [Starter-Code]