Welcome to Monica, a well-organized API project designed for easy integration into any delivery application. This API collection includes comprehensive features to manage delivery processes and is integrated with Stripe for seamless payment handling.
Monica is built to support a complete delivery application, especially suited for coffee delivery. This API solution includes all essential routes, authentication mechanisms, order handling, and payment integration using Stripe to simplify transaction processes.
- 📦 Order Management: Easily create, view, update, and delete orders.
- 👥 User Authentication: Secure user login and signup functionalities.
- 💳 Stripe Integration: Smooth and secure payment processing.
- 🚚 Delivery Status Tracking: Track and update the delivery status in real-time.
- 📊 Analytics: Basic analytics for orders and revenue tracking.
Ensure you have the following installed on your machine:
- Node.js: Install Node.js
- npm: Comes with Node.js installation
- Stripe Account: Sign up for Stripe
To clone and set up this repository, follow these steps:
-
Clone the repository
git clone https://github.com/your-username/coffee_deliver_apis.git cd coffee_deliver_apis
-
Install dependencies
npm install
-
Set up environment variables
- Create a
.env
file in the root directory and add your Stripe API key and other required credentials.
- Create a
-
Run the application
npm start
The server should start, and you’ll see the output indicating it's up and running on the defined port.
Here are the main API endpoints available in this repository:
GET /orders
: Retrieve a list of all ordersPOST /orders
: Create a new orderPUT /orders/:id
: Update an orderDELETE /orders/:id
: Delete an order
POST /signup
: User signupPOST /login
: User login
POST /payments
: Process payment via Stripe
PUT /deliveries/:id
: Update delivery statusGET /deliveries
: Retrieve all deliveries
GET /analytics
: View order and revenue analytics
Thank you for checking out this repository! This project was crafted with care and dedication by Beni Samuel. I hope it serves your application’s needs effectively!
Feel free to contribute, raise issues, or suggest features to make this project even better!
Happy coding! 😊