aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f044841
--- /dev/null
+++ b/README.md
@@ -0,0 +1,53 @@
+# 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.
+
+O mesmo é um sub-projeto do Eletrocast, um projeto do qual também faço parte.
+
+## Tecnologias Utilizadas
+
+- **Frontend**: Next.js
+- **Backend**: Node.js
+- **Banco de Dados**: Supabase (PostgreSQL)
+
+## Como Executar o Projeto
+
+1. Clone o repositório:
+ ```bash
+ git clone https://github.com/seu-usuario/eletrocast-eleicoes.git
+ ```
+2. Instale as dependências:
+ ```bash
+ npm install
+ ```
+3. Inicie o servidor:
+ ```bash
+ npm start
+ ```
+
+## 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).