https://github.com/wesgtox/navedex-api

An API to register navedex’s and projects in which they participated.
https://github.com/wesgtox/navedex-api

api api-rest django django-rest-framework documentation flake8 gunicorn insomnia postgresql pytest pytest-django python

Last synced: about 2 months ago
JSON representation

An API to register navedex’s and projects in which they participated.

Host: GitHub
URL: https://github.com/wesgtox/navedex-api
Owner: WesGtoX
License: mit
Created: 2020-08-22T02:15:06.000Z (about 5 years ago)
Default Branch: main
Last Pushed: 2022-08-11T02:50:26.000Z (about 3 years ago)
Last Synced: 2025-07-19T05:30:01.428Z (3 months ago)
Topics: api, api-rest, django, django-rest-framework, documentation, flake8, gunicorn, insomnia, postgresql, pytest, pytest-django, python
Language: Python
Homepage: https://navedex-wes.herokuapp.com/
Size: 5.5 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

About  |
Technology  |
Getting Started  |
Usage  |
License

GitHub top language
GitHub language count
GitHub last commit
GitHub issues
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](https://www.python.org/)
- [Django Framework](https://www.djangoproject.com/)
- [Django REST Framework](https://www.django-rest-framework.org/)

## Getting Started

### Prerequisites

- [Python](https://www.python.org/)

### Install and Run

1. Clone the repository:
```bash
git clone https://github.com/WesGtoX/navedex-api.git
```
2. Create and activate a virtual enviroment:
```bash
python -m venv venv
source venv/bin/activate
```
3. Install the dependencies:
```bash
pip install -r requirements-dev.txt
```
4. Run migrations:
```bash
python manage.py makemigrations
python manage.py migrate
```
5. Create a superuser:
```bash
python manage.py createsuperuser
```
6. Run:
```bash
python manage.py runserver
```
7. To run tests:
```bash
pytest
# or
python manage.py test
```

## Usage

### Insomnia

[![Run in Insomnia}](https://insomnia.rest/images/run.svg)](https://insomnia.rest/run/?label=Navedex&uri=https%3A%2F%2Fraw.githubusercontent.com%2FWesGtoX%2Fnavedex-api%2Fmaster%2Fnavedex_insomnia.json)

Insomnia Example