diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 59 |
1 files changed, 13 insertions, 46 deletions
@@ -1,53 +1,20 @@ -# Eletrocast Eleições +Eletrocast Eleições -Bem-vindo ao repositório do **Eletrocast Eleições**! Este projeto tem como objetivo fornecer uma plataforma para fazer uma eleição justa para o grêmio estudantil. +Projeto de código aberto para gerenciamento de eleições do grêmio estudantil. -O mesmo é um sub-projeto do Eletrocast, um projeto do qual também faço parte. +Requisitos: Next.js, Node.js, Supabase (PostgreSQL) -## Tecnologias Utilizadas +Instalação: +git clone https://github.com/zwlucas/eletrocast-eleicoes.git +cd eletrocast-eleicoes +npm install -- **Frontend**: Next.js -- **Backend**: Node.js -- **Banco de Dados**: Supabase (PostgreSQL) +Uso: +npm start -## Como Executar o Projeto +Contribuição: +Relate bugs ou envie patches via Pull Request. -1. Clone o repositório: - ```bash - git clone https://github.com/zwlucas/eletrocast-eleicoes.git - ``` -2. Instale as dependências: - ```bash - npm install - ``` -3. Inicie o servidor: - ```bash - npm start - ``` +Licença: MIT License -## Contribuição - -Contribuições são bem-vindas! Siga os passos abaixo para contribuir: - -1. Faça um fork do projeto. -2. Crie uma branch para sua feature: - ```bash - git checkout -b minha-feature - ``` -3. Faça o commit das suas alterações: - ```bash - git commit -m "Minha nova feature" - ``` -4. Envie para o repositório remoto: - ```bash - git push origin minha-feature - ``` -5. Abra um Pull Request. - -## Licença - -Este projeto está licenciado sob a [MIT License](LICENSE). - -## Contato - -Para dúvidas ou sugestões, entre em contato pelo e-mail: [dsn.lucas@outlook.com](mailto:dsn.lucas@outlook.com). +Contato: dsn.lucas@outlook.com |