recipe-api

KO | EN

gitlite — search

#hacktoberfest #react #typescript #android #rust #linux #macos #windows #cli #awesome-list #vue #security #pytorch #open-source

(★ 32)

A recipe sharing API built using Django rest framework.

recipe-api Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Recipe Sharing API

This API allows users to share recipes and find recipes. It is developed using Django rest framework. You can find the api [here](https://recipe-backend-api.herokuapp.com/).

## Basic Features

- Custom `User` model and authentication using email and password.
- JWT authentication.
- CRUD endpoints for recipe.
- Search functionality for recipes.
- Password reset functionality.
- Documentation using `drf_spectacular` which support OAS3.
- Unit test using coverage and factory boy.
- Frontend is built using React.js and can be found [here](https://github.com/earthcomfy/Recipe-app).

## Quick Start

To get this project up and running locally on your computer follow the following steps.

1. Clone this repository to your local machine.
2. Create a python virtual environment and activate it.
3. Open up your terminal and run the following command to install the packages used in this project.

```
$ pip install -r requirements.txt
```

4. Set up a Postgres database for the project.
5. Rename the `.env.example` file found in the root directory of the project to `.env` and update
   the environment variables accordingly. **Note:** For local development, leave the Cloudinary configs empty.
6. Run the following commands to setup the database tables and create a super user.

```
$ python manage.py migrate
$ python manage.py createsuperuser
```

7. Run the development server using:

```
$ python manage.py runserver
```

8. Open a browser and go to http://localhost:8000/.

## License

Usage is provided under the [MIT License](http://opensource.org/licenses/mit-license.php). See LICENSE for the full details.

recipe-api

recipe-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

recipe-api

recipe-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README