Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nasirovx/generici-api

🤖Generic API project using **DRF** and **Docker**. Making it easy to deploy🐳 and manage using Docker. 🐳
https://github.com/nasirovx/generici-api

api django-rest-framework docker dockerignore generic

Last synced: about 2 months ago
JSON representation

🤖Generic API project using **DRF** and **Docker**. Making it easy to deploy🐳 and manage using Docker. 🐳

Awesome Lists containing this project

README

        

# 🌟 Generic API + Docker + DRF 🚀

This project serves as an educational example of creating an API using Generic Views in Django. The project is authored by Marselle. You can contact the author [here](https://instagram.com/5ekastan).

## Project Description

Generic API Project demonstrates the use of Django to create an API using Generic Views. Generic Views provide a convenient way to handle various CRUD (Create, Retrieve, Update, Delete) operations for Django models.

## Installation

1. Clone the repository:

```bash
git clone [email protected]:nasirovx/Generic-Api.git
```

2. Navigate to the project directory:

```bash
cd Generic-Api
```

3. Install dependencies:

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

4. Apply migrations:

```bash
python manage.py migrate
```

## Running the Project

1. Start the development server:

```bash
python manage.py runserver
```

2. Open a web browser and go to [http://localhost:8000/](http://localhost:8000/) to access the API.

## Using the API

The project includes several Generic Views for the model that can be used to perform various CRUD operations. You should also familiarize yourself with [Django REST framework](https://www.django-rest-framework.org/) for more detailed information on creating APIs with Django.

## Contact the Author

The project author, Marselle, is available on [Instagram](https://instagram.com/5ekastan). Feel free to reach out to him for feedback, questions, or additional information.

## License

This project is distributed under the [MIT License](LICENSE). You are free to use, modify, and distribute it in accordance with the terms of this license.