Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mohamedhnoor/store-api
The Store Management API is a robust and flexible solution designed to streamline the operations of a retail or e-commerce store. Leveraging the power of Node.js, Express, and MongoDB, this API provides a seamless platform for managing products, orders, and customers efficiently.
https://github.com/mohamedhnoor/store-api
dotenv express mongodb mongoose nodejs nodemon
Last synced: about 1 month ago
JSON representation
The Store Management API is a robust and flexible solution designed to streamline the operations of a retail or e-commerce store. Leveraging the power of Node.js, Express, and MongoDB, this API provides a seamless platform for managing products, orders, and customers efficiently.
- Host: GitHub
- URL: https://github.com/mohamedhnoor/store-api
- Owner: MohamedHNoor
- License: mit
- Created: 2024-02-10T18:34:13.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-02-12T17:03:34.000Z (10 months ago)
- Last Synced: 2024-02-12T19:39:45.212Z (10 months ago)
- Topics: dotenv, express, mongodb, mongoose, nodejs, nodemon
- Language: JavaScript
- Homepage:
- Size: 24.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Store Management API
> A powerful API for managing store operations efficiently. Built with Node.js, Express, and MongoDB.
## Built With
- JavaScript
- Node.js
- Express
- MongoDB
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
In order to run this project you need:
- Node.js installed on your machine
- MongoDB installed and running locally or accessible remotely
### Setup
Clone this repository to your desired folder:
```sh
cd
git clone https://github.com/MohamedHNoor/store-api.git
```
### Install
Install dependencies with:
```sh
npm install
```
### Usage
To run the project, execute the following command:
```sh
npm start
```
### Configuration
Ensure MongoDB is running, and configure the connection URI in an environment variable named MONGO_URI. You can set it in a .env file or directly in your environment.
```sh
Example .env file:
MONGO_URI=mongodb://localhost:27017/store
```
### API Endpoints
- Create Product: POST `api/v1/Products`
- Read Product: GET `api/v1/Products/:id`
- Update Product: PATCH `api/v1/Products/:id`
- Delete Product: DELETE `api/v1/Products/:id`
- List Products: GET `api/v1/Products`
## Authors
👤 **Mohamed Hassan Noor**
- GitHub: [@MohamedHNoor](https://github.com/MohamedHNoor)
- Twitter: [@MohamedHNoor](https://twitter.com/MohamedHNoor)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/mohamedhnoor/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/MohamedHNoor/store-api/issues).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- Hat tip to [@john-smilga](https://github.com/john-smilga) for his invaluable teachings in his Node.js course.
- Inspiration
- etc
## 📝 License
This project is [MIT](./LICENSE) licensed.