( Em Desenvolvimento )
API REST, desenvolvida em Node.js, de uma aplicação para a transportadora fictícia, chamada FastFeet.
Este projeto faz parte do desafio final da turma 11 do RocketSeat GoStack Bootcamp
Rotas | Executando | Tecnologias | Licença
Por meio desta API, é possível realizar requisições para:
Usuário
- Criar
POST: http://localhost:3333/users
- Atualizar **
PUT: http://localhost:3333/users/:id
Sessão
- Criar
POST: http://localhost:3333/sessions
- Atualizar *
PUT: http://localhost:3333/sessions
Destinatário
- Criar **
POST: http://localhost:3333/recipients
- Atualizar **
PUT: http://localhost:3333/recipients/:id
(*) - Rotas em que só são possíveis realizar requisicões estando autenticado.
(**) - Rotas em que só são possíveis realizar requisicões estando autenticado e com privilégio de administrador.
Obs.: Ao realizar a requisição de Sessão, é retornado um Token, que deve ser utilizado em requisições para rotas em que é necessário um usuário autenticado.
Para esse projeto foi utilizado um container de Docker de PostgreSQL.
Para executar o projeto assim como foi desenvolvido, crie um container Docker com o comando:
docker run --name postgresDB -e POSTGRES_PASSWORD=docker -p 5432:5432 -d postgres:11
Caso já possua um banco PostgreSQL, um container de Docker para o mesmo ou até mesmo utiliza de outro banco de dados relacional, basta apenas alterar as credenciais de conexão com o banco no arquivo database.js.
Para clonar e executar esse projeto, você precisará de Git, Node v12.14 ou maior e Yarn v1.21.1 ou maior instalados em seu computador. Com isso, utilize os comandos:
# Clone este repositório
$ git clone https://github.com/patrickt26/node-fastfeet.git
# Acesse o repositório
$ cd node-fastfeet
# Instale as dependências
$ yarn install
# Execute o projeto
$ yarn dev
(Obs.: o projeto estará rodando em http://localhost:3333)
As principais tecnologias utilizadas foram:
- Node.js(v12.14.0)
- Yarn(v1.21.1)
- Express(v.4.17.1)
- nodemon(v.2.0.2)
- Sucrase(v.3.12.1)
- Docker(v.19.03.5)
- Sequelize(v.5.21.3)
- PostgreSQL(v.11)
- node-postgres(v.7.18.1)
- Bcrypt(v2.4.3)
- JWT(v8.5.1)
- Yup(v.0.28.1)
- VS Code com ESLint(v.6.8.0) e EditorConfig(v.0.14.4)
- Prettier(v.1.19.1)
Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.
Feito com ♥ por Patrick Thomaz 👋 Get in touch!