🏠 Roommates 🚧
Sobre • Como executar • Tecnologias • Autor • Licença
💻 Sobre o projeto
🏠 Roommates - é uma plataforma que conecta pessoas á quartos de aluguel.
Projeto desenvolvido para fins de estudo.
🚀 Como executar o projeto
Este projeto é divido em duas partes:
- Backend
- Frontend
💡Frontend precisa que o Backend esteja sendo executado para funcionar.
Pré-requisitos
Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js versão 14.x. Além disto é bom ter um editor para trabalhar com o código como VSCode
🎲 Rodando o Backend (servidor)
# Clone este repositório
$ git clone git@github.com:falaigor/roommates-api.git
# Acesse a pasta do projeto no terminal/cmd
$ cd roommates-api
# Instale as dependências
$ npm install ou yarn
# Execute a aplicação em modo de desenvolvimento
$ npm run dev ou yarn dev
# O servidor inciará na porta:4000 - acesse http://localhost:4000
.env
Renomeie o .env.example no diretório raiz para .env e atualize com suas configurações.
Foi utilizado o Cloudinary para armazenamento das imagens em CDN.
| key | description | default |
|---|---|---|
| CLOUDINARY_CLOUD_NAME | Token do MAPBOX | |
| CLOUDINARY_API_KEY | KEY gerada na sua conta Cloudinary | |
| CLOUDINARY_API_SECRET | SECRET KEY gerada na sua conta Cloudinary | |
| CLOUDINARY_API_ENV | API Environment variable | |
| STORAGE_TYPE | Tipo de Storage dos Arquivos | cloudinary |
🧭 Rodando a aplicação web (Frontend)
Seguir as Instruções para rodar a aplicação Frontend
🛠 Tecnologias
As seguintes ferramentas foram usadas na construção do projeto:
Website (React + TypeScript)
Veja o arquivo package.json
Server (NodeJS + TypeScript)
Veja o arquivo package.json
Utilitários
- Protótipo: Figma
- Maps: Leaflet
- Editor: Visual Studio Code → Extensions: SQLite
- Markdown: StackEdit, Markdown Emoji
- Commit Conventional: Commitlint
- Teste de API: Insomnia
- Ícones: Feather Icons
- Fontes: Ubuntu, Roboto
💪 Como contribuir para o projeto
- Faça um fork do projeto.
- Crie uma nova branch com as suas alterações:
git checkout -b my-feature - Salve as alterações e crie uma mensagem de commit contando o que você fez:
git commit -m "feature: My new feature" - Envie as suas alterações:
git push origin my-feature
🦸 Autor
Igor Santos 🚀
📝 Licença
Este projeto esta sobe a licença MIT.
Feito com ❤️ por Igor Santos 👋🏽 Entre em contato!