Skip to content

Commit

Permalink
📜 docs: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
henriquesebastiao committed Feb 5, 2024
1 parent 4555401 commit b99a222
Showing 1 changed file with 4 additions and 31 deletions.
35 changes: 4 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,9 @@

Um simples sistema de controle de ponto eletrônico para resolver o meu problema de geral um pdf automaticamente ao fim do mês 😄.

## Como usar localmente
Timesheet é desenvolvido com Django, utilizando o banco de dados PostgreSQL e a lib `reportlab` para a geração do PDF no fim do mês. Toda a interação com a aplicação é feita através do painel administrativo do Django.

```shell
git clone https://github.com/henriquesebastiao/timesheet.git
cd timesheet
python3 -m venv venv
source venv/bin/activate
pip install .
```
Você pode testar a aplicação em [timesheet-hick.fly.dev](https://timesheet-hick.fly.dev/) com o usuário de demostração:

Defina a variável de ambiente `DEBUG` como `1` para rodar o servidor em modo de desenvolvimento com um banco de dados SQLite.

```shell
export DEBUG=1
```

```shell
python manage.py migrate
```

Crie um super usuário para acessar o painel de administração.

```shell
python manage.py createsuperuser
```

Rode o servidor de desenvolvimento.

```shell
python manage.py runserver
```

Acessar o painel de administração em `http://localhost:8000/` e entrar com o usuário criado anteriormente.
- **Usuário**: `user-demo`
- **Senha**: `Demo@123`

0 comments on commit b99a222

Please sign in to comment.