O Caroneiros 🚗 é o fruto do projeto de conclusão do Bootcamp do curso de Back-End da {Reprograma}, com a orientação da professora Paula Allemand. A ideia para construir essa aplicação surgiu a partir de uma observação sobre um problema recorrente encontrado na cidade onde resido, como também na região (Santo Amaro - BA, região do Recôncavo Baiano).
Essa região possui cidades geograficamente muito próximas, levando ao evento onde as pessoas comumente moram em uma cidade e trabalham/estudam em outras. Além do fato de que, por serem cidades do interior, geralmente não há tanta diversidade em opções de lazer como nas grandes cidades e capitais. Com isso, a procura por caronas entre as cidades vem aumentando progressivamente.
Outro fator importante que levou a criação desse projeto é que, apesar de ter cobertura na maioria das cidades da Bahia, grandes aplicativos como iFood, Uber, Waze Carpool, Bla Bla Car não funcionam aqui na região. Entretanto, o que funciona por aqui são aplicações feitas por desenvolvedores locais, com grande participação dos usuários.
Observando essas questões, juntamente com a grande busca por caronas nas redes sociais (stories no Instagram e grupos no Facebook), o Caroneiros 🚗 tem como principal objetivo juntar pessoas que precisam de caronas com quem tem para oferecer, de forma mais prática e efetiva.
O projeto final é uma API Rest fundamentada no método CRUD, que são: Create (criar), Read (leitura), Update (atualizar), Delete (deletar).
A construção do projeto contou com as seguintes tecnologias:
📁 api-caroneiros
|
|- 📁 src
| |
| |- 📁 controller
| |- 📑 anuncioController.js
| |- 📑 carroController.js
| |- 📑 caronaController.js
| |- 📑 usuarioController.js
|
| |- 📁 database
| |- 📑 mongoConfig.js
|
| |- 📁 helpers
| |- 📑 auth.js
|
| |- 📁 models
|- 📑 anuncioSchema.js
| |- 📑 carroSchema.js
| |- 📑 caronaSchema.js
| |- 📑 usuarioSchema.js
|
| |- 📁 routes
| |- 📑 anuncioRoutes.js
| |- 📑 carroRoutes.js
| |- 📑 caronaRoutes.js
| |- 📑 index.js
| |- 📑 usuarioRoutes.js
|
| |- 📑 app.js
|
|- 📑 Procfile
|- 📑 LICENSE.md
|- 📑 .env
|- 📑 .env.example
|- 📑 .gitignore
|- 📑 package-lock.json
|- 📑 package.json
|- 📑 README.md
|- 📑 server.js
-
Cadastrar: usuário, carro e anúncio e a carona (viagem).
-
Buscar/Listar: Todos anúncios de caronas estão disponíveis, com os seguintes filtros: anúncio por ID, se há espaço na mala, se aceita transportar animais e se há possibilidade de transportar crianças no assento próprio para elas.
-
Atualizar e deletar usuários, carros e anúncios e caronas, com permissão da autenticação.
-
Local: http://localhost:9090 (rodando localmente)
-
Heroku: https://api-caroneiros.herokuapp.com/ (consumir API)
-
Utilize o Postman ou Insomnia para realizar as chamadas e testar os endpoints da API localmente ou via Heroku.
| Método HTTP | Endpoint | Descrição |
|---|---|---|
| GET | / |
Retorna página de apresentação do projeto |
| Método HTTP | Endpoint | Descrição |
|---|---|---|
| GET | /usuarios/todos |
Retorna todos os usuários |
| POST | /usuarios/criar |
Cria/cadastra um novo usuário |
| POST | /usuarios/login |
Login de usuario |
| PATCH | /usuarios/atualizar/:id |
Atualiza informações do usuario |
| DELETE | /usuarios/deletar/:id |
Deleta usuário |
| Método HTTP | Endpoint | Descrição |
|---|---|---|
| GET | /anuncios/todos |
Retorna todos os anuncios |
| GET | /anuncios/filtros |
Retorna anuncios por filtros específicos |
| GET | /anuncios/:id |
Retorna anuncio por ID |
| POST | /anuncios/criar |
Cria/cadastra um novo anuncios |
| PATCH | /anuncios/atualizar/:id |
Atualiza informações do anuncio |
| DELETE | /anuncios/deletar/:id |
Deleta anuncio |
| Método HTTP | Endpoint | Descrição |
|---|---|---|
| GET | /carros/todos |
Retorna todos os carros |
| POST | /carros/criar |
Cria/cadastra um novo carro |
| PATCH | /carros/atualizar/:id |
Atualiza informações do carro |
| DELETE | /carros/deletar/:id |
Deleta carro |
| Método HTTP | Endpoint | Descrição |
|---|---|---|
| GET | /caronas/todas |
Retorna todos as caronas |
| POST | /caronas/criar |
Cria/cadastra uma nova carona |
| PATCH | /caronas/atualizar/:id |
Atualiza informações da carona |
| DELETE | /caronas/deletar/:id |
Deleta carona |
- id: gerado automaticamente
- Usuário: id do usuário, obrigatório
- Data da viagem: tipo string e obrigatório
- Local de saída e local de chegada: tipo string e obrigatório
- Turno e horário: tipo string e obrigatório
- Carro: id do carro, obrigatório
- Espaço na mala, aceita pets e cadeira de bebê: tipo boolean, obrigatório
- Vagas: tipo number, obrigatório
API deve retornar seguinte JSON:
{
"_id": "61ba79173f9d32b8326a311a",
"usuario": "61ba6d2124b4d77ed675c0c1",
"dataViagem": "16/12/2021",
"localSaida": "Muritiba",
"localChegada": "Cruz das Almas",
"turno": "manhã",
"horario": "07h",
"carro": "61ba76cb8f1aa8427e16035b",
"arCondicionado": true,
"espacoMala": false,
"vagas": 3,
"aceitaPets": false,
"cadeiraBebe": false,
"__v": 0
}- id: gerado automaticamente
- Dono: id do usuário, obrigatório
- Marca e modelo: tipo string e obrigatório
- Ano: tipo number e obrigatório
- Placa: tipo string e obrigatório
- Airbags, ar condicionado, cadeira bebê: tipo boolean, obrigatório
- Tamanho mala: tipo number, obrigatório
API deve retornar seguinte JSON:
{
"_id": "61ba76cb8f1aa8427e16035b",
"dono": "61ba6d2124b4d77ed675c0c1",
"marca": "Fiat",
"modelo": "Argo",
"ano": 2019,
"placa": "AAA2020",
"airbags": true,
"arCondicionado": true,
"tamanhoMala": 500,
"cadeiraBebe": true,
"__v": 0
}- id: gerado automaticamente
- Nome: tipo string, obrigatório
- Email: tipo string e obrigatório
- Idade: tipo number e obrigatório
- RG: tipo string e obrigatório
- Telefone: tipo string e obrigatório
- Data de criação: tipo Date, gerado automaticamente e obrigatório
- Senha: tipo string, obrigatório
API deve retornar seguinte JSON:
{
"_id": "61bbd52a0a1388268be23b9e",
"nome": "erika freitas",
"email": "erikafreitas47@gmail.com",
"idade": 25,
"rg": "1112223330",
"telefone": "75982971924",
"dataCriacao": "2021-12-17T00:00:31.924Z",
"senha": "$2b$10$tr7fzXqD31AYMnNzBRjQ/Oo6qdFVjiD7mC776fmxwKYk/5YC9IFpG",
"__v": 0
}- id: gerado automaticamente
- anúncio carona: id do anúncio, obrigatório
- usuario carona: id do usuário, obrigatório
API deve retornar seguinte JSON:
{
"_id": "61ba7a59be11ca33a9b07ac8",
"anuncioCarona": "61b1737b0ef9db440ac38473",
"usuarioCarona": "61ba6d2124b4d77ed675c0c1",
"__v": 0
}❌ Em andamento
- Proteção de dados
- Fazer buscas mais refinadas
- Fazer checagem no banco de dados para cadastros
- Implementar canal de mensagem entre quem oferece e quem busca a carona
- Deixar comentários e likes/dislikes sobre o motorista e a viagem
- Opção de dividir gasolina
- Opção de caronas para encomendas
- Faça um fork do projeto.
- Crie uma nova branch com as suas alterações: git checkout -b seu-nome
- Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "minhas mudanças"
- Envie as suas alterações: git push origin seu-nome
Agradeço a toda equipe da Reprograma. Entrar para esse curso foi, sem dúvidas, uma das maiores alegrias desse ano. Além de ser uma grande esperança de melhorias no futuro. Agradeço à todas as professoras que tive durante as semanas do curso. Conheci tantas mulheres incríveis que, com certeza, me inspiraram a seguir e aprender mais. A nossa querida facilitadora, as nossas monitoras sempre presentes, e principalmente as minhas colegas de turma. Essas mulheres incríveis que com certeza acompanharei para o resto da vida. Passar esses meses ao lado dessas mulheres foi uma experiência incrível de empatia e solidariedade. Eu tenho certeza que nunca esquecerei de nenhuma. Agradeço demais a minha família, por me incentivar a voltar para os estudos e possibilitar que isso acontecesse. Agradeço a cada amigo que torceu e vibrou comigo cada pequena conquista nos códigos. Agradeço também a mim, pois não foram meses fáceis e precisei de muita determinação para seguir. Daqui para frente, lembrarei de tudo isso. ❤️
Esse projeto está sob a licença MIT.