Skip to content

mariamandafm/foodplace-app-api

Repository files navigation

Python Django DjangoREST Docker Postgres

FoodPlace API

API for a restaurant website. This API integrates with restaurant websites, offering management capabilities for menus, carts, and orders.

Build With

  • Django REST Framework

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

The front-end interface in JavaScript for this API can be found in: front-end.

Prerequisites

The things you need before installing the software.

  • Docker

Installation

Clone the repository:

$ git clone https://github.com/mariamandafm/foodplace-app-api.git
$ cd foodplace-app-api

Build the images and start the Docker containers:

$ docker compose build
$ docker compose up

Testing

Running the unit tests:

$ sudo docker-compose run --rm app sh -c "python manage.py test"

Documentation

The Swagger documentation of the API can be find in the path api/docs/.

About

Restaurant API project with Python and Django

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors