ControlCash 💸

Sistema para controle de caixa e gerenciamento de estoque simplificado desenvolvido usando Django.

Documentação

Nessa seção você encontra a documentação usada para construir esse projeto.

Documento de visão

Documento de modelos

Documento de user stories

Plano de releases

Plano de iterações

Tutoriais

Esse projeto é construído usando o framework Django, a seguir você confere alguns tutoriais que ensinam mais sobre essa tecnologia.

Escrevendo seu primeiro app Django (Documentação oficial) - Artigos

Django 4 CRUD Completo em ~30 minutos (Canal Gregory Pacheco) - Vídeo

Tutorial Django: Website da Biblioteca Local (MDN Docs) - Artigos

Python Django Tutorial for Beginners (Canal Programming with Mosh) - Vídeo

Como executar o projeto

Você pode executar o projeto utilizando o mariadb através do docker ou usar o SQLite3 padrão do django.

Tutorial com o SQLite
Tutorial com docker e mariadb

Com o SQLite

Possuir o python 3.9 ou superior instalado no computador.
Criar um ambiente virtual para instalar as dependências do projeto. Para isso execute um dos comandos a seguir
```
python -m venv venv
```
ou
```
python3 -m venv venv
```
Precisamos ativar o venv para que as depedências sejam instaladas na pasta local do projeto. Para isso basta executar um dos comandos a seguir.
- Windows
```
.\venv/Scripts/activate
```
- Linux/Mac
```
source venv/bin/activate
```
Agora precisamos instalar as dependências, para isso basta executar o seguinte comando
- Windows
```
python -m pip install -r requirements.txt
```
- Linux/Mac
```
python3 -m pip install -r requirements.txt
```
Feito isso, precisamos entrar na pasta do projeto
```
cd controlcash
```
Copie o arquivo .env.example e o renomeie para .env
- Linux
```
cp .env.example .env
```
- Windows
```
copy .env.example .env
```
Feito o passo anterior, agora precisamos fazer as migrações usando os comandos a seguir
```
python manage.py makemigrations
```
```
python manage.py migrate
```
Agora podemos executar o projeto
```
python manage.py runserver
```
Agora acesse a URL mostrada no terminal:
- http://localhost:8000/produto

Com o MariaDB via Docker

Possuir o python 3.9 ou superior instalado no computador.
Criar um ambiente virtual para instalar as dependências do projeto. Para isso execute um dos comandos a seguir
```
python -m venv venv
```
ou
```
python3 -m venv venv
```
Precisamos ativar o venv para que as depedências sejam instaladas na pasta local do projeto. Para isso basta executar um dos comandos a seguir.
- Windows
```
.\venv/Scripts/activate
```
- Linux/Mac
```
source venv/bin/activate
```
Agora precisamos instalar as dependências, para isso basta executar o seguinte comando
- Windows
```
python -m pip install -r requirements.txt
```
- Linux/Mac
```
python3 -m pip install -r requirements.txt
```
Feito isso, precisamos entrar na pasta do projeto
```
cd controlcash
```
Copie o arquivo .env.example e o renomeie para .env
- Linux
```
cp .env.example .env
```
- Windows
```
copy .env.example .env
```
Crie um diretorio para o volume do container com o MariaDB
```
mkdir -p $HOME/docker/volumes/controlcash-db
```

Inicie um container docker com o MariaDB

Lembre-se de alterar o valor da variável MARIADB_ROOT_PASSWORD para a senha que deseja utilizar em seu banco

docker run --name mariadb-controlcash -v $HOME/docker/volumes/controlcash-db:/var/lib/mysql -e MARIADB_ROOT_PASSWORD=controlcash -d -p 3306:3306 mariadb:latest

Acesse o MariaDB via terminal com o comando abaixo, ele solicitará a senha que você definiu no passo anterior
```
docker exec -it mariadb-controlcash mariadb --user root -p
```
Crie um banco de dados para a aplicação
```
create database controlcash;
```
Saia do terminal do MariaDB com o comando exit, e abra o arquivo .env no seu editor de código favorito.
Preencha o arquivo .env com os dados do banco de dados que você acabou de criar, e altere a variável USE_SQLITE para False.
Feito o passo anterior, agora precisamos fazer as migrações usando os comandos a seguir
```
python manage.py makemigrations
```
```
python manage.py migrate
```
Agora podemos executar o projeto
```
python manage.py runserver
```
Agora acesse a URL para a página de produtos:
- http://localhost/produto

Em caso de erro

Ao instalar os pacotes com o pip

Instale os pacotes a seguir no linux

sudo apt update

sudo apt install libmariadb-dev python3-dev default-libmysqlclient-dev build-essential

Ao tentar executar a aplicação

No arquivo ControlCash/settings.py, verifique se a configuração do banco de dados está com HOST igual a localhost, caso esteja, troque para 127.0.0.1.

Deve estar parecido com isso:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'controlcash',
        'USER': 'controlcash',
        'PASSWORD': 'controlcash',
        'HOST': '127.0.0.1',
        'PORT': 3306
    }
}

amendoncabh/controlcash