Skip to content

transparenciaunicamp/transparenciaunicamp-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API Transparência Unicamp

Admin interface available at http://transparenciaunicamp-api.herokuapp.com/admin/

Install

Requirements

We use Django in the backend. That said the basic requirement is Python 3.5 with pip (virtualenv recommended).

Dependencies

Once you have pip available let's install the dependencies:

pip install -r requirements.txt

Settings

Copy contrib/.env.sample as .env in the project's root folder and adjust your settings.

At this point it's crucial to configure the acceess to you database (PostgreSQL is not required, but recommended).

Migrations

Once you're done with requirements, dependencies and settings, create the basic structure at the database and create a super-user for you:

python manage.py migrate
python manage.py createsuperuser

Ready?

Not sure? Run python manage.py check and python manage.py test just in case.

Accessing the API

Run the server with python manage.py runserver and load localhost:8000 with your favorite browser.

If you want to test the login required area, as a developer you can login through Django Admin and then go back to the root.