RefHub (Refreshinery Hub) is an internal API designed to manage the ordering of food by staff. The system allows staff to log in, enter their food orders with item names and prices, and an additional transportation fee is charged. The API also supports generating a consolidated PDF of all orders for the admin. Integration with Paystack is included for payment processing.
- Staff can log in and submit food orders (item and price).
- A fixed transportation charge is applied to all orders.
- Admin can view all orders and generate a PDF report with staff names and orders.
- Paystack payment integration for handling payments.
- Backend: Django, Django REST Framework
- Payment: Paystack API
- API Documentation: Swagger (using drf-yasg)
- PDF Generation: ReportLab (for creating the PDF of orders)
-
Clone the repository:
git clone https://github.com/Temples-Dev/refhub-api.git cd refhub-api -
Install pipenv if you don't have it:
pip install pipenv
-
Install the required dependencies:
pipenv install
-
Activate the virtual environment:
pipenv shell
-
Run database migrations:
python manage.py migrate
-
Create a superuser (for admin access):
python manage.py createsuperuser
-
Run the development server:
python manage.py runserver
To enable Paystack for payment processing, you'll need to add your Paystack secret key to the Django settings.
In settings.py, add the following:
PAYSTACK_SECRET_KEY = "your-paystack-secret-key"Swagger documentation is automatically generated. To access the API documentation, navigate to:
http://localhost:8000/swagger/
-
Order Entry:
POST /api/orders/
Staff can submit an order with an item name and price. -
View All Orders (Admin only):
GET /api/orders/
Admin can view all orders and generate a PDF report. -
Generate PDF Report:
GET /api/orders/pdf/
Generates a PDF report of all orders with staff names. -
Paystack Payment:
POST /api/payment/
Handles payment via Paystack.
To run tests:
python manage.py testThis project is licensed under the MIT License. See the LICENSE file for details.