https://github.com/blossom-babs/milestone-storefront
Storefront API handles the backend logic and database integration of an online shopping store.
https://github.com/blossom-babs/milestone-storefront
database nodejs postgres postgresql
Last synced: 3 months ago
JSON representation
Storefront API handles the backend logic and database integration of an online shopping store.
- Host: GitHub
- URL: https://github.com/blossom-babs/milestone-storefront
- Owner: blossom-babs
- Created: 2022-03-27T20:35:30.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-03T12:32:41.000Z (over 3 years ago)
- Last Synced: 2025-03-12T07:16:42.405Z (over 1 year ago)
- Topics: database, nodejs, postgres, postgresql
- Language: TypeScript
- Homepage: https://github.com/blossom-babs/milestone-storefront
- Size: 396 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Storefront API
Storefront API handles the backend logic and database integration of an online shopping store.
## Features
Based on project requirements, the following features are covered for this endpoint:
1. Create products for the online store
2. View all the products that are available in the store
3. View all the products in a category
4. View a single product
5. Delete product
6. Create users account
7. Authenticate users account
8. List available users
9. Allow authenticated users to place an order on a product
## Dependencies
This project was bootstrapped with the following tools:
1. [PostgreSQL](https://www.postgresql.org/)
2. [Typescript](https://www.typescriptlang.org/)
3. [Node](https://nodejs.org/en/)
4. [ExpressJs](https://expressjs.com/)
5. [eslint linter](https://eslint.org/)
6. [Prettier code formatter](https://prettier.io/)
All of these dependencies required are listed in the package.json file. Use `npm install` on the command line.
Environment variables are defined in a .env file.
> However, you will need to install node and postgreSQL on your local machine
## Installation
The steps outline will provide a walkthrough on how to install the app on your local machine
1. Clone this repository `git clone https://github.com/blossom-babs/milestone-storefront`
2. From the terminal, change directory to storefront app folder `cd milestone-storefront`
3. Run `npm install` from your terminal in your project directory to install all dependencies
4. Then run the app with the command `npm run watch`
If you wish to contribute to this project, before any of the steps above, you would need to __fork__ this project first.
You're ready to hack (and | or contribute) ✌️
## Usage
The endpoints available for tests can be found in the ***requirements.md*** file
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
## Authors
🌸 __Blossom__
- Github: [@blossom-babs](https://github.com/blossom-babs/)
- LinkedIn: [Blossom Babalola](https://www.linkedin.com/in/blossom-babalola/)
- Twitter: [@BlossomBabalola](https://twitter.com/BlossomBabalola)
### Show your support
- Give a ⭐ if you like this project
- [Buy me a coffee](https://www.buymeacoffee.com/blossombabs)