Skip to content

Commit

Permalink
Update index.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mascDriver authored Mar 24, 2023
1 parent 738d5ac commit 198112a
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Portal do Aluno Mobile

O Portal do Aluno Mobile é um projeto open source em React Native com Expo que permite aos alunos visualizarem suas notas do semestre ou de todo o período letivo. Este projeto se conecta à API do Portal do Aluno, que está hospedada em outro projeto open source [apiPortalAluno](https://github.com/mascDriver/apiPortalAluno).


## :iphone: O aplicativo está disponível em:
[Versão BETA](https://github.com/mascDriver/portal-aluno/releases/tag/0.0.1).

#### :coffee: Para me pagar um café :coffee:
PIX :money_with_wings: :money_with_wings: :money_with_wings: :
```
[email protected]
```

### :rocket: Funcionalidades

O Portal do Aluno Mobile oferece as seguintes funcionalidades:

* Visualização das notas do semestre atual;
* Visualização das notas de todo o período letivo;
* Cálculo automático da média ponderada do aluno;
* Interface intuitiva e fácil de usar.


### :books: Como usar

Para usar o Portal do Aluno Mobile, basta seguir os seguintes passos:

1. Clone o repositório em sua máquina local: git clone https://github.com/mascDriver/portal-aluno.git.
2. Instale o Expo CLI: npm install -g expo-cli.
3. Instale as dependências do projeto: npm install.
4. Inicie o servidor do Expo: expo start.
5. Abra o aplicativo Expo em seu dispositivo móvel.
6. Escaneie o QR code que aparece no terminal do seu computador para abrir o Portal do Aluno
7. Mobile em seu dispositivo móvel.


### :computer: Tecnologias utilizadas


O Portal do Aluno Mobile foi desenvolvido utilizando as seguintes tecnologias:

* React Native: Biblioteca JavaScript para a criação de aplicativos móveis;
* Expo: Plataforma para a criação de aplicativos móveis em React Native;


### :fist: Contribuindo

Se você deseja contribuir com o Portal do Aluno Mobile, sinta-se à vontade para enviar suas sugestões e melhorias através de pull requests. Para garantir que sua contribuição seja aceita, siga as seguintes diretrizes:

* Faça um fork do repositório e crie uma branch para suas alterações;
* Mantenha suas alterações coesas e atômicas;
* Adicione testes para suas alterações, se possível;
* Certifique-se de que seus commits sigam as convenções de commit do projeto;
* Faça um push de suas alterações para seu fork e envie um pull request.

### :mortar_board: Licença

O Portal do Aluno Mobile é um software de código aberto licenciado sob a Licença MIT. Veja o arquivo LICENSE para mais detalhes.

0 comments on commit 198112a

Please sign in to comment.