/Sacsis-Api

Api restful para o site e aplicativo da sacsis ufv.

Primary LanguagePythonApache License 2.0Apache-2.0

XI SACSIS − Api 🛠️

  • Projeto desenvolvido com 📦
    • Flask-Restful - Flask-RESTful is an extension for Flask that adds support for quickly building REST APIs
    • Flask-SQLAlchemy - Flask-SQLAlchemy is an extension for Flask that adds support for SQLAlchemy to your application
    • Flask-JWT-Extended's - An open source Flask extension that provides JWT support
    • Flask-Mail - The Flask-Mail extension provides a simple interface to set up SMTP
    • Flask-CORS - A Flask extension for handling Cross Origin Resource Sharing (CORS)
    • Flask-Excel - Flask-Excel is based on pyexcel and makes it easy to consume/produce information stored in excel files over HTTP protocol as well as on file system
    • Gunicorn - Gunicorn (Green Unicorn) is a Python WSGI HTTP Server for UNIX

Variaveis de Ambiente 💻🔧

Variavel Descrição
MASTER_ADM_LOGIN Login para o administrador mestre (padrão: admin@admin.br)
MASTER_ADM_PASSWORD Senha para o administrador mestre (padrão: admin)
SQLALCHEMY_DATABASE_URI URI de conexão com o banco de dados
JWT_SECRET_KEY Chave secreta para a geração do token
JWT_ACCESS_TOKEN_EXPIRES Quantidade em dias de expiração da sessão do usuário
TOKEN_KEY Chave secreta para a geração do token do formulario de palestras e minicursos
MAIL_SERVER URI do servidor do endereço de email
MAIL_PORT Porta padrão 465
MAIL_USERNAME Login do servidor de email
MAIL_PASSWORD Senha de login do servidor de email
MAIL_DEFAULT_SENDER Endereço de email do remetente
MAIL_USE_TLS Padrão: false
MAIL_USE_SSL Padrão: true

Executando localmente 🏭

Para configurar e executar o projeto de forma automatica e necessario ter o Docker e o Docker Compose previamente instalado. Caso não o possua basta seguir o guia oficial clicando aqui

# clonando repositório
$ git clone https://github.com/LuisMSoares/Sacsis-Api
$ cd Sacsis-Api

# instalando dependências e rodando a aplicação
$ docker-compose up --build

Documentação da Api 📖

Acesse a documentação da API clicando aqui.

Licença 🔒

Apache-2.0