Esse é o código atualizado para a Students API.
API escrita em Typescript, utilizando o framework ExpressJS para implementação de rotas e a biblioteca Celebrate para validação de dados.
- src: Pasta contendo arquivos de código fonte da aplicação
- controllers: Pasta contendo os controladores da aplicação, definindo métodos que serão utilizados nas rotas
- db: Definição simples de um database temporário utilizando o singleton pattern
- types: Pasta contendo definição de tipos da aplicação
- routes: Definição das rotas da api
- server: Definição do servidor da aplicação
- tests: Pasta contendo testes da aplicação
Para execução da aplicação é necessário ter o NodeJS
instalado, seja por meio do site oficial ou por meio de um gestor de versões como o NVM
Após ter o NodeJS
instalado, rode o seguinte comando para instalar as dependências da aplicação.
npm install
Duplique o arquivo .env.example
e de o nome de .env
. Nele, coloque as variáveis de ambiente conforme definidas no exemplo.
Para iniciar a aplicação em modo de desenvolvimento, basta fazer a seguinte modificação no .env
NODE_ENV=development
E executar o seguinte comando
npm run dev
A aplicação deverá iniciar na porta especificada no arquivo .env
Para iniciar a aplicação em modo de produção, primeiro deve ser feita a seguinte modificação no .env
NODE_ENV=production
Após isso a aplicação deve ser compilada, a afim de obtermos uma versão em Javascript puro. Isso pode ser realizado por meio do seguinte comando
npm run build
Por fim, basta executar o seguinte comando para iniciar a aplicação
npm start
A aplicação deverá iniciar na porta especificada no arquivo .env
Para executar os testes, basta rodar o seguinte comando
npm run test
- Aylton Almeida