Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/itxsaaad/store-api-express-task13b
https://github.com/itxsaaad/store-api-express-task13b
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/itxsaaad/store-api-express-task13b
- Owner: itxSaaad
- License: mit
- Created: 2024-07-26T09:43:58.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-03T15:23:27.000Z (3 months ago)
- Last Synced: 2024-08-03T17:16:42.013Z (3 months ago)
- Language: JavaScript
- Size: 22.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Store API - Express Task 13b
> A simple store API with CRUD operations and Search functionality built with Express.js
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
## Features
- **CRUD Operations**: Create, Read, Update, and Delete products
- **Search Functionality**: Search for products by name
- **RESTful API**: Follows RESTful API conventions
- **MongoDB Database**: Uses MongoDB as the database
- **Express.js**: Built with Express.js
## Built With
- [Node.js](https://nodejs.org/en/) - JavaScript runtime built on Chrome's V8 JavaScript engine
- [Express.js](https://expressjs.com/) - Fast, unopinionated, minimalist web framework for Node.js
- [MongoDB](https://www.mongodb.com/) - General purpose, document-based, distributed database
- [Mongoose](https://mongoosejs.com/) - Elegant MongoDB object modeling for Node.js
- [Postman](https://www.postman.com/) - Collaboration platform for API development
- [VS Code](https://code.visualstudio.com/) - Code editor redefined and optimized for building and debugging modern web and cloud applications
## Getting Started
### Prerequisites
- [Node.js](https://nodejs.org/en/) - JavaScript runtime built on Chrome's V8 JavaScript engine
- [NPM](https://www.npmjs.com/) - Node Package Manager
### Installation
1.Clone the repo
```sh
git clone https://github.com/itxSaaad/store-api-express-task13b.git
```
2.Navigate to the project directory
```sh
cd store-api-express-task13b
```
3.Install dependencies
```sh
npm install
```
4.Run the project
```sh
npm start
```
## Contributing
Contributions are what make the open-source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the repo
2. Clone the project
3. Create your feature branch (`git checkout -b feature/AmazingFeature`)
4. Commit your changes (`git commit -m "Add some AmazingFeature"`)
5. Push to the branch (`git push origin feature/AmazingFeature`)
6. Open a pull request
## Contact
- Twitter: [@itxSaaad](https://twitter.com/itxSaaad)
- LinkedIn: [@itxSaaad](https://www.linkedin.com/in/itxsaaad/)
- Portfolio: [@itxSaaad](https://portfolio-itxsaaad.vercel.app/)
- Email: [[email protected]](mailto:[email protected])
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Support
Give ⭐️ if you like this project!
[contributors-shield]: https://img.shields.io/github/contributors/itxSaaad/store-api-express-task13b.svg?style=for-the-badge
[contributors-url]: https://github.com/itxSaaad/store-api-express-task13b/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/itxSaaad/store-api-express-task13b.svg?style=for-the-badge
[forks-url]: https://github.com/itxSaaad/store-api-express-task13b/network/members
[stars-shield]: https://img.shields.io/github/stars/itxSaaad/store-api-express-task13b.svg?style=for-the-badge
[stars-url]: https://github.com/itxSaaad/store-api-express-task13b/stargazers
[issues-shield]: https://img.shields.io/github/issues/itxSaaad/store-api-express-task13b.svg?style=for-the-badge
[issues-url]: https://github.com/itxSaaad/store-api-express-task13b/issues
[license-shield]: https://img.shields.io/github/license/itxSaaad/store-api-express-task13b.svg?style=for-the-badge
[license-url]: https://github.com/itxSaaad/store-api-express-task13b/blob/main/LICENSE.md