Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vinniciusgomes authored Dec 5, 2020
1 parent 0578a80 commit 14bb5a0
Showing 1 changed file with 82 additions and 0 deletions.
82 changes: 82 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
<h1 align="center">
<img alt="AchaRep" title="Acharep" src="https://raw.githubusercontent.com/vinniciusgomes/acharep/master/.github/acharep-logo.png" width="150px" />
</h1>

<h4 align="center">
Reinvente seu jeito de encontrar repúblicas<br/>
<br />
🚧 Em desenvolvimento 🚧
</h4>
<p align="center">
<img alt="GitHub language count" src="https://img.shields.io/github/languages/count/vinniciusgomes/acharep-api">

<img alt="Repository size" src="https://img.shields.io/github/repo-size/vinniciusgomes/acharep-api">

<a href="https://github.com/vinniciusgomes/acharep-api/commits/master">
<img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/vinniciusgomes/acharep-api">
</a>

<a href="https://github.com/vinniciusgomes/acharep-api/issues">
<img alt="Repository issues" src="https://img.shields.io/github/issues/vinniciusgomes/acharep-api">
</a>

<img alt="License" src="https://img.shields.io/badge/license-MIT-brightgreen">
</p>

<p align="center">
<a href="#rocket-tecnologias">Tecnologias</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
<a href="#-projeto">Projeto</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
<a href="#-layout">Layout</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
<a href="#-como-contribuir">Como contribuir</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
<a href="#memo-licença">Licença</a>
</p>

<br>

<p align="center">
<img alt="Frontend" src="https://raw.githubusercontent.com/vinniciusgomes/acharep/master/.github/acharep.png" width="100%">
</p>
<p align="center">
<img alt="Frontend" src="https://raw.githubusercontent.com/vinniciusgomes/acharep/master/.github/ios.png" width="100%">
</p>
<p align="center">
<img alt="Frontend" src="https://raw.githubusercontent.com/vinniciusgomes/acharep/master/.github/android.png" width="100%">
</p>

## :rocket: Tecnologias

Esse projeto foi desenvolvido com as seguintes tecnologias:

- [Node.js](https://nodejs.org/en/)
- [Mongodb](https://www.mongodb.com)
- [Mongoose](https://mongoosejs.com)
- [Express](https://expressjs.com)

## 💻 Projeto

##### O Problema:
Atualmente, existem dois métodos populares para procurar repúblicas, que são os conselhos de repúblicas e grupos de facebook, mas, os universitários de outras cidades e estados que necessitam de uma moradia no local do seu centro acadêmico, acabam não tendo conhecimento de tais canais de comunicação, sendo assim, acabam tendo uma grande dificuldade de conseguir uma república.

##### Solução:
O AchaRep é um projeto que visa criar um buscador de repúblicas em um único lugar, onde você consegue encontrar a rep perfeita perto da sua universidade.

## 🔖 Layout

Você pode ver o layout do projeto através [desse link](https://xd.adobe.com/view/beef8f2a-4dcb-41b6-4032-0b8c0e0ba2d2-c8de/).

## 🤔 Como contribuir

- Faça um fork desse repositório;
- Cria uma branch com a sua feature: `git checkout -b minha-feature`;
- Faça commit das suas alterações: `git commit -m 'feat: Minha nova feature'`;
- Faça push para a sua branch: `git push origin minha-feature`.

Depois que o merge da sua pull request for feito, você pode deletar a sua branch.

## :memo: Licença

Esse projeto está sob a licença MIT. Veja o arquivo [LICENSE](LICENSE.md) para mais detalhes.

---

##### Feito com ♥ by Vinnicius Gomes

0 comments on commit 14bb5a0

Please sign in to comment.