william-ribeiro / api-healthy-mind Goto Github PK

Sobre • Funcionalidades • Como executar • Tecnologias • Autor • Licença

🚀 Healthy Mind - é a API do sistema web que visa conectar Psicólogos/Psiquiatras com seus pacientes.

A API é um desafio prosposto durante a jornada Dev For Tech proposto pela Gama Academy.

• [V] Cadastro de profissionais:
• [V] Autenticação JWT,
• [V] Refresh token,
• [V] Cadastramento de Pacientes
• [V] Cadastramento de sessões

• NodeJS -> Docs
• Docker -> Getting started
• Criar seu arquivo .env com base no .env.example

Clone este repositório:

git clone [email protected]:william-ribeiro/api-healthy-mind.git

Acesse a pasta do projeto no terminal/cmd:

cd api-healthy-mind

Crie um arquivo .env com base no env.example

PORT=4000
NODE_ENV="local"
DATABASE_URL="postgres://postgres:gamma@data:5432/gamma"
DATABASE_MIGRATIONS="./src/database/migrations/*.ts"
DATABASE_ENTITIES="./src/modules/**/*.ts"
DATABASE_MIGRATIONS_DIR="./src/database/migrations"
SECRET_ACCESS_TOKEN="crie-seu-secret"
SECRET_REFRESH_TOKEN="crie-seu-secret"

Execute o comando NO LINUX

yarn docker:linux-start

ou no Windows/Mac

yarn docker:start

• Instala as dependências;
• Instancia o servidor e o banco de dados
• Executa as migrações
• Executa os testes automaticamente (apenas linux)
• Sobe o servidor

Para parar o servidor primeiro execute no Linux/Windows ctrl+c , no Mac command+c e logo após:

yarn docker:stop

Outros comandos:

• Rodar os testes unitários

yarn docker:tests

• Executar migrações

yarn docker:migrate

• Reverter a ultima migração

yarn docker:revert

http://localhost:4000/api-docs

Foi utilizado na aplicação as seguintes tecnologias

• Express
• Typeorm
• Jest
• Docker
• JWT
• UUID

1. Faça um fork do projeto.
2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -S -m "feature: My new feature"
4. Envie as suas alterações: git push origin my-feature

   Caso tenha alguma dúvida confira este guia de como contribuir no GitHub

1. Crie uma nova issue, incluindo o label correspondente.
2. Crie a branch atraves da issue
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -S -m "feature: My new feature"
4. Envie as suas alterações: git push origin my-feature
5. Abra um pull request

   Caso tenha alguma dúvida confira este Como criar uma solicitação de pull

_{William Ribeiro}

Este projeto esta sobe a licença MIT.