Skip to content

apyb/associados

Repository files navigation

Associados PythonBrasil

Projeto open source para o controle de associados da associação PythonBrasil

O projeto é desenvolvido por voluntários, utilizando principamente Python e Django e Twitter Bootstrap

Preparando o ambiente

Recomenda-se utilizar o virtualenv para manter o ambiente isolado de suas aplicações. Testado com Python 3.6.9, Postgresql 9.5.4 e Django 1.11.29.

Você precisa instalar o postgresql em sua máquina antes de continuar.

No Ubuntu:

$ sudo apt-get install postgresql

No Mac OS X com Homebrew:

$ brew install postgresql

Consulte sua distribuição para saber como preparar o postgres.

Exemplo, para instalar o banco de dados em /tmp/pgdata (temporário):

$ sudo apt-get install python-psycopg2
$ pg_ctl initdb -D /tmp/pgdata
$ pg_ctl start -D /tmp/pgdata
$ su postgres psql -U postgres # para roots: psql -d postgres 
postgres=# create user associados createdb createuser password 'assocdev';
postgres=# create database associados owner associados;
postgres=# \q

Você pode mudar os parâmetros locais, como banco de dados, copiando o arquivo: associados/example_settings.ini para associados/settings.ini e editando o arquivo com suas preferências. Os settings primeiro verificam variáveis de ambiente e depois as definições do settings.ini.

Ou seja, se você definir $ export DEBUG=True, o valor do DEBUG em settings.ini não será avaliado.

Instalar

$ make setup

Rodando a aplicação localmente

$ make run

Rodando os testes

$ make test

Ambiente com Docker

Caso queira subir o ambiente com Docker, temos um docker-compose.yml com o PostgreSQL e o Django. No arquivo, também é possível alterar as informações de acesso do PostgreSQL.

Instalar o Docker e o Docker-Compose.

Primeiramente vamos buildar nossos serviços web e db com o comando docker-compose build. Quando finalizar, estaremos prontos para rodar os primeiros comandos usando o bin/run como atalho.

  • Para rodar o migrate: ./bin/run python manage.py migrate
  • Para carregar nossas fixtures com o loaddata: ./bin/run python manage.py loaddata app/core/fixtures/site_init.json
  • E por fim para rodar o servidor de desenvolvimento Django, você só precisa deste comando: make run-with-docker. Esse comando vai levantar nosso servidor juntamente com as dependências de qualquer outro serviço (no nosso caso, db)

Caso queria realizar os testes, usar o comando ./bin/run python manage.py test.

Como contribuir?

Reporte os bugs e compartilhe o patches baseada nas nossas Issues ou simplesmente faça um fork do projeto, contribua com o que achar necessário e mande pra gente! :)

Build Status

Coverage Status

Code Climate

Issue Count