WelissonLuca/school_api

SCHOOL_API

📕 Índice

• 📋 Sobre
• 🕹 Tecnologias
• 🧑🏽‍💻 Iniciando o projeto
• 👨🏽‍🔧 Contribuições
• 📝 Licença
• 🦸 Contatos

---

Sobre

Aplicação desenvolvida como teste para vaga de desenvolvedor back-end JR.

Tecnologias

• Tecnologias
  • Node JS
    • TypeScript
  • Express
  • TypeORM
    • PostgresSQL
• Dependências
  • Babel
  • Eslint
  • Jest
  • Reflect-metadata
  • Tsyringe

---

Iniciando

Pré-requisitos

• Node JS

  https://nodejs.org/en/

• Yarn ou Npm

  https://yarnpkg.com/

• PostgresSQL

  https://www.postgresql.org/

---

Instalação e uso

# Execute este comando para clonar o projeto
$ git clone https://github.com/WelissonLuca/school_api
# ou use a opção de download.

# Entre na pasta com
$ cd test-back-end-JR

# Instale as dependências
$ yarn ou npm install

# Crie o banco de dados e as tabelas utilizando o comando
$ yarn typeorm migration:run ou npm typeorm migration:run

# Rode a aplicação usando o comando
$ yarn dev ou npm run dev

Documentação swagger

• http://localhost:3333/api-docs/

Link para deploy da aplicação no heroku

• https://schoolapijr.herokuapp.com/api-docs//

Licença

Distribuído sob a licença MIT. Veja LICENSE para mais informações.

Contatos

@WelissonLuca