https://github.com/davidsantana06/farma-server
API REST desenvolvida para atender às demandas de uma rede de farmácias de manipulados.
https://github.com/davidsantana06/farma-server
api-rest docker nestjs prisma sqlite
Last synced: 8 months ago
JSON representation
API REST desenvolvida para atender às demandas de uma rede de farmácias de manipulados.
- Host: GitHub
- URL: https://github.com/davidsantana06/farma-server
- Owner: davidsantana06
- License: mit
- Created: 2025-01-06T14:36:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-14T18:43:42.000Z (over 1 year ago)
- Last Synced: 2025-02-14T19:29:16.938Z (over 1 year ago)
- Topics: api-rest, docker, nestjs, prisma, sqlite
- Language: TypeScript
- Homepage: https://farma-server.onrender.com
- Size: 458 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### 💊 Farma Server
API REST desenvolvida para atender às demandas de uma rede de farmácias de manipulados, inspirada no conceito da **Oficial Farma**. Este projeto foi criado como parte de uma atividade acadêmica, com o objetivo de explorar tecnologias modernas e boas práticas no desenvolvimento de sistemas escaláveis




### 🛠️ Instalação e Configuração
O sistema foi projetado para ser executado via **Docker**, proporcionando maior portabilidade e facilidade na configuração. Para iniciar a instalação, é necessário obter uma cópia local do código-fonte. Isso pode ser feito utilizando o comando:
```bash
git clone https://github.com/davidsantana06/farma-server
```
Após clonar o repositório, é necessário criar um arquivo `.env` com base no modelo disponível em `.env.example`, especificando o valor de `PORT` — a porta na qual a aplicação será executada.
Com o arquivo `.env` configurado, o servidor pode ser executado com o comando:
```bash
docker compose up
```
Para encerrar a execução, utilize:
```bash
docker compose down
```
### 🧪 Cobertura de Testes
O servidor conta com testes unitários que validam suas principais funcionalidades implementadas na camada de serviço. Para executar os testes, utilize o comando:
```bash
npm run test
```
### ⚖️ Licença
Este repositório adota a **Licença MIT**, permitindo o uso e a modificação do código como desejar. Peço apenas que seja dado o devido crédito, reconhecendo o esforço e o tempo investidos no desenvolvimento.