/Grocery-Store-API

The Grocery Store API is a RESTful API designed for managing product inventory in grocery stores. Built with JavaScript, Node.js, Express, MongoDB, EJS and jQuery Mobile, it offers CRUD functionality for creating, reading, updating, and deleting products.

Primary LanguageEJSMIT LicenseMIT

Grocery-Store-API

The Grocery Store API is a robust and feature-rich RESTful API designed to facilitate the management of products within a grocery store. Built using JavaScript, Node.js, Express, MongoDB, and jQuery Mobile, this API offers a comprehensive CRUD (Create, Read, Update, Delete) interface for interacting with product data. It is hosted with FL0.

Endpoints

  • GET /: Retrieve all products.
  • GET /:bc: Retrieve a specific product by barcode.
  • GET /delete/:bc: Retrieve a specific product to delete by barcode.
  • POST /: Insert a new product.
  • POST /:bc: Update an existing product by barcode.

Dependencies

  • chalk: ^5.3.0
  • ejs: ^3.1.9
  • express: ^4.18.2
  • mongoose: ^8.1.1
  • morgan: ^1.10.0

Development Dependencies

  • dotenv: ^16.4.1
  • nodemon: ^3.0.3

Getting Started

To get started with the Grocery Store API, follow these steps:

  1. Clone the repository to your local machine.
  2. Install dependencies using npm install.
  3. Create a .env file and configure environment variables as needed.
  4. Start the server using npm start.
  5. Access the API endpoints to manage products.

Deployment

The Grocery Store API is ready for deployment. Simply host it on your preferred platform and ensure that environment variables are appropriately configured.

Contributing

Contributions to the project are welcome! To contribute, fork the repository, make your changes, and submit a pull request.

License

This project is under the MIT License. Please refer to the LICENSE file for more details.

Contact

If you have questions, suggestions, or comments, don't hesitate to get in touch with me. You can reach me at my social media.

Farewell

I hope you find this repository useful for learning and practicing. If you have any questions or need assistance, please feel free to contact me. Enjoy exploring my GitHub profile!

Thank you for considering the Grocery Store API!