UniSocial - FrontEnd

Descrisão

---

Este é um projeto que visa ajudar a Unibelas a comunicar com os seus estudantes sabendo sobre o que eles pensam sobre determinados fatores, a informar os estudantes sobre os assuntos da instituição, dar voz aos estudantes em assuntos.

🚧 O UniSocial 🚀 Em construção... 🚧

Tabela de sumários

• Descrisão
• Tabela de sumários
• Interfaces
• Pré-requisitos para usar o project
• Passa para Instalação
• Tecnologias
• Norma de como trabalhar
• contribuidores

Interfaces

Módulos ads:

[] Login
[] Sighup
[] Publicação
[] Home

Cores

---

• laranjaClaro-300: #FFC745;
• fundo: #FFF;
• laranjaClaro-200: #F2B705;
• laranjaEscuro-400: #F28705;
• laranjaEscuro-200: #FF9F00;
• fundo-noite: #262626;
• cinzaClaro-200: #A3A3A3;
• cinzaClaro-400: #A6A6A6;
• preta: #000000;

Pré-requisitos usar

---

Antes de começar, você vai precisar ter instalado em sua máquina a seguinte ferramenta que é o Git. Além disto é bom ter um editor para trabalhar com o código como VSCode, a extensão do vscode ESLint para mostrar error de sintaxe, a extensão prettier para facilitar em ler e escrever regra do pretttier,a [EditorConfig] para manter padrão independentemente do editor de codigo,e a yarn para gerenciamento dos pacotes.

Passo para instalação

---

# Clone este repositório
$ git clone <https://github.com/franciscojoaopedro/uni-social-backend.git>

# Acesse a pasta do projeto no terminal/cmd
$ cd uni-social

# Instale as dependências
$ npm install

# Execute a aplicação em modo de desenvolvimento
$ npm run dev

# O servidor inciará na porta:3333 - acesse <http://localhost:3333>

🛠 Tecnologias

---

As seguintes ferramentas foram usadas na construção do projeto:

• vite
• React
• pritter
• eslint
• editorConfig
• husky
• lint-staged

Norma de como trabalhar no Projeto

---

1. Trabalhar só nos sábados e domingos horário a sua escolha.
2. Relatar sobre as alterações feitas no projeto no grupo do facebook ou whatsapp.
3. Documentar código verboso.
4. Escrever o código em português assim como os commits.
5. Refactor código que achas que deverias fazer melhor antes de lançar no github.
6. Qualquer erro que está dando, tenta primeiro solucionar antes, se não conseguir comunica sobre o erro.
7. Criar sempre uma branch quando se trabalha numa funcionalidade ou interface.

     ex: 
       Antes de desenvolver:
         git branch feat/login - criar uma branch
         git checkout feat/login - ativar para começar
   
       Depois desenvolver tudo:
         git checkout main - ativar o main
         git merge feat/login - junta todos os feitos da branch feat/login ao main.
         git branch feat/login -D - deletar a branch.  
   

8. Ao fazer um git push deve-se fazer sempre isto.

   ex:
     git pull - para baixar novas alterações.
     git push ou git push origin main - casos não ouver conflitos 
   

Contribuidores

---

Ngunga dev : franciscojoaopedro1998@gmail.com

Walany Costa : walanycosta@outlook.com

Gouveia51 : GouveiaGaspar51@gmail.com