https://github.com/geffrerson7/task-api

django django-rest-framework docker mysql python simple-jwt swagger

Last synced: about 2 months ago
JSON representation

API for create and check tasks

Host: GitHub
URL: https://github.com/geffrerson7/task-api
Owner: Geffrerson7
License: bsd-3-clause
Created: 2023-03-21T23:10:26.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-03-27T16:51:57.000Z (about 2 years ago)
Last Synced: 2025-04-06T10:49:54.447Z (about 1 year ago)
Topics: django, django-rest-framework, docker, mysql, python, simple-jwt, swagger
Language: Python
Homepage:
Size: 19.5 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

README

# TASK-API

## Description
All app made with django-rest-framework and has the functions of user sign-up and login and also task creation.

## Getting Started

First clone the repository from Github and switch to the new directory:
```bash
$ clone git https://github.com/Geffrerson7/TASK-API.git
```

```bash
$ cd TASK-API
```

Create the virtual enviroment
```bash
$ virtualenv venv
```

Activate the virtual enviroment for your project.
```bash
# windows
$ source venv/Scripts/activate
# Linux
$ source venv/bin/activate
```

Install project dependencies:
```sh
(venv)$ pip install -r requirements.txt
```

Then simply apply the migrations:
```sh
(venv) $ python manage.py makemigrations
(venv) $ python manage.py migrate
```

You can now run the development server:
```sh
(venv)$ python manage.py runserver
```

And navigate to
```sh
http://127.0.0.1:8000/
```

## Local Installation with Docker

Clone the respository

```bash
$ git clone https://github.com/Geffrerson7/TASK-API.git
```

Navigate to the new directory

```bash
$ cd TASK-API
```

Run the command
```sh
$ docker-compose up
```

And navigate to
```sh
http://127.0.0.1:8000/
```

## Author

- [Gefferson Max Casasola Huamancusi](https://www.github.com/Geffrerson7)