Skip to content

Latest commit

 

History

History
82 lines (56 loc) · 1.94 KB

README_EN.md

File metadata and controls

82 lines (56 loc) · 1.94 KB

python3-badge enter image description here

API Enquetes

It provides an API to query the participation of polls data through a REST architecture

Installation

There are two ways to install this project. The first is using Docker and the second is using Pipenv. Both ways the project will run on port 8005. Being accessible through the link:

Docker

Requirements

It's necessary to instal this softwares:

  • Docker
  • Docker-Compose
  • Create a file with name .env on same folder file settings.py it is. You need to create the following environment variables.
SECRET_KEY=
DEBUG=
ALLOWED_HOSTS=
ENGINE= 
NAME=
HOST=
PORT=
USER_DB=
PASSWORD=
DRIVER=

1 - Open your terminal and clone this repository by typing

git clone https://github.com/labhackercd/api_enquetes.git

2 - Navigate to the root directory and enter

cd api_enquetes
docker-compose up

Pipenv

1 - Open your terminal and clone this repository by typing

git clone https://github.com/labhackercd/api_enquetes.git

First of all, you need to install pipenv. After install these dependencie you can run the follow commands:

pipenv install

Running

pipenv run src/manage.py runserver 0.0.0.0:8005

Support

Fell free to create any issue on this repository and contact the team responsible to maintain this project here on GitHub (@erivanio, @thiagonf, @joaopaulonsoares and @teogenesmoura) or via email: [email protected].

Contributing

  1. Fork of this repository
  2. Write your code
  3. Create a Pull Request
  4. Our team will review your PR and merge as soon as possible!

License

This project is under GPLv3 License