Está API está sendo desenvolvida para um sistema de alugueis de carros.
O projeto ainda está em desenvolvimento e as próximas atualizações serão voltadas nas seguintes tarefas:
- CRUD de categorias
- CRUD de especificações
- CRUD dos carros
- CRUD dos aluguéis
- CRUD dos usuários
- Criptografia de senha
- Autenticação JWT
- Upload de imagens
- Testes automatizados
Veja a análise de requisitos Análise de requisitos
Antes de começar, verifique se você atendeu aos seguintes requisitos:
- Você precisa instalar o NodeJs V14.x+
Para rodar o rentX, siga estas etapas:
Baixe o projeto e instale as dependências:
# Clone este repositório
git clone https://github.com/Chriszao/rentx.git
# Entre na pasta do projeto
cd rentx
# instale as dependências
npm install | yarn install
Para usar rentx, siga estas etapas:
<!-- work in progress -->
Para contribuir com rentx, siga estas etapas:
- Bifurque este repositório.
- Crie um branch:
git checkout -b <nome_branch>. - Faça suas alterações e confirme-as:
git commit -m '<mensagem_commit>' - Envie para o branch original:
git push origin <nome_do_projeto> / <local> - Crie a solicitação de pull.
Como alternativa, consulte a documentação do GitHub em como criar uma solicitação pull.
Esse projeto está sob licença. Veja o arquivo LICENÇA para mais detalhes.
Developed with 💙 by Chriszao