Orkestro @ FATEC-ZL

Tecnologias

Descrição

• Orkestro é uma plataforma web de gerenciamento de cardápios desenvolvida para otimizar a rotina de pequenos comércios, centralizando a administração de produtos, preços e pedidos de forma simples e eficiente.

• Desenvolvido a partir dos conhecimentos adquiridos na Faculdade de Tecnologia da Zona Leste (FATEC-ZL), o projeto possui caráter acadêmico e busca simular práticas e processos utilizados em equipes reais de desenvolvimento de software.

Pré-requisitos

Para executar o projeto, as seguintes tecnologias são necessárias:

• Python instalado (a versão >= 3.12.3 é utilizada neste projeto);
• Docker e Docker Compose;
• Uma IDE de sua preferência (PyCharm, VSCode);
• Make (para automação de tarefas em ambientes GNU/Linux).

Rodar localmente

1. Clone o repositório do projeto:

git clone git@github.com:TechAbraao/orkestro.git
cd ./orkestro

2. Crie o ambiente virtual (.venv):

# Linux / macOS
python3 -m venv .venv
source .venv/bin/activate

# Windows
python -m venv .venv
.venv\Scripts\activate

3. Instale todas as dependências necessárias para desenvolvimento:

pip install -r ./source/requirements/requirements-dev.txt

4. Configure todas as variáveis de ambiente presentes em .env.template:

FLASK_APP=source.app:create_app
FLASK_ENV=development
FLASK_DEBUG=1
SECRET_KEY=[]
PYTHONPATH=$(pwd)
FLASK_HOST=localhost
FLASK_PORT=[]
DATABASE_HOST=[]
DATABASE_PORT=[]
DATABASE_NAME=[]
POSTGRES_USER=[]
POSTGRES_PASSWORD=[]
POSTGRES_DB=[]
PGADMIN_DEFAULT_EMAIL=[]
PGADMIN_DEFAULT_PASSWORD=[]
PGADMIN_HOST=[]
PGADMIN_PORT=[]
REDIS_HOST=[] 
REDIS_PORT=[]
ADMIN_EMAIL=[]
ADMIN_PASSWORD=[]

Notas:

• As configurações das variáveis de ambiente são de extrema importância para a inicialização do projeto. Em caso de dúvidas, consulte um dos mantenedores.

5. Renomeie o arquivo .env.template para .env:

# Linux / macOS
mv .env.template .env

# Windows (PowerShell)
Rename-Item .env.template .env

6. Na raiz do projeto, inicialize os containers Docker:

• Utilizando o Makefile:

make up

• Caso não possua o make instalado, execute diretamente o Docker Compose:

docker compose -f ./source/docker/compose/docker-compose.yml up -d

7. Após isso, faça as migrations:

flask db upgrade

8. Rode o projeto:

flask run 

9. Acesse a aplicação:

http://localhost:<port>