About  |   Technology  |   Getting Started  |   Usage  |   License

Navedex API

About the Project

Navedex is an API to register navedex’s and projects in which they participated.

The project was developed using the Django REST Framework which is Django's toolkit, powerful and flexible to build API’s Web.

Technology

This project was developed with the following technologies:

• Python
• Django Framework
• Django REST Framework

Getting Started

Prerequisites

• Python

Install and Run

1. Clone the repository:

git clone https://github.com/WesGtoX/navedex-api.git

2. Create and activate a virtual enviroment:

python -m venv venv
source venv/bin/activate

3. Install the dependencies:

pip install -r requirements-dev.txt

4. Run migrations:

python manage.py makemigrations
python manage.py migrate

5. Create a superuser:

python manage.py createsuperuser

6. Run:

python manage.py runserver

7. To run tests:

pytest
# or
python manage.py test

Usage

Insomnia

For more examples, please refer to the Documentation

License

Distributed under the MIT License. See LICENSE for more information.

---

Made with ♥ by Wesley Mendes 👋