https://github.com/benisamuel/coffee_deliver_apis
A well organised apis you can integrate into an application of delivering things integrated with stripe for payment
https://github.com/benisamuel/coffee_deliver_apis
expressjs stripe-payments
Last synced: 5 months ago
JSON representation
A well organised apis you can integrate into an application of delivering things integrated with stripe for payment
- Host: GitHub
- URL: https://github.com/benisamuel/coffee_deliver_apis
- Owner: BeniSamuel
- Created: 2024-08-11T18:01:19.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-11-09T10:19:05.000Z (7 months ago)
- Last Synced: 2024-11-09T11:21:37.071Z (7 months ago)
- Topics: expressjs, stripe-payments
- Language: JavaScript
- Homepage:
- Size: 38.1 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ☕ Coffee Deliver APIs
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.
---
## 📋 Table of Contents
- [About](#about)
- [Features](#features)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Usage](#usage)
- [Endpoints](#endpoints)
- [Made with ❤️ by Beni Samuel](#made-with--by-beni-samuel)
---
## 📖 About
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.
---
## 🌟 Features
- 📦 **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.
---
## 🚀 Getting Started
### Prerequisites
Ensure you have the following installed on your machine:
- **Node.js**: [Install Node.js](https://nodejs.org/)
- **npm**: Comes with Node.js installation
- **Stripe Account**: [Sign up for Stripe](https://stripe.com/)
### Installation
To clone and set up this repository, follow these steps:
1. **Clone the repository**
```bash
git clone https://github.com/your-username/coffee_deliver_apis.git
cd coffee_deliver_apis
```
2. **Install dependencies**
```bash
npm install
```
3. **Set up environment variables**
- Create a `.env` file in the root directory and add your Stripe API key and other required credentials.
4. **Run the application**
```bash
npm start
```
The server should start, and you’ll see the output indicating it's up and running on the defined port.
---
## 📄 Usage
Here are the main API endpoints available in this repository:
### 📦 Orders
- `GET /orders`: Retrieve a list of all orders
- `POST /orders`: Create a new order
- `PUT /orders/:id`: Update an order
- `DELETE /orders/:id`: Delete an order
### 👥 User Authentication
- `POST /signup`: User signup
- `POST /login`: User login
### 💳 Payments
- `POST /payments`: Process payment via Stripe
### 🚚 Delivery
- `PUT /deliveries/:id`: Update delivery status
- `GET /deliveries`: Retrieve all deliveries
### 📊 Analytics
- `GET /analytics`: View order and revenue analytics
---
## ❤️ Made with Love by Beni Samuel
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! 😊