Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add readme and docs folder #30

Merged
merged 1 commit into from
Mar 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions CONTRIBUTING.md

This file was deleted.

48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Progress Track

Este projeto, liderado por Micael Mota em colaboração com seus seguidores do YouTube, visa criar uma ferramenta de acompanhamento de metas. A ideia é desenvolver uma aplicação que ajude os usuários a acompanhar e registrar seu progresso em diversas áreas da vida, como educação, saúde, hobbies, entre outros.

## Sobre o Projeto

O Progress Track é uma iniciativa para fornecer uma plataforma acessível e intuitiva para que os usuários possam monitorar seu desenvolvimento pessoal ao longo do tempo. Através desta aplicação, eles poderão definir metas, registrar seu progresso e obter insights sobre seu crescimento em diferentes aspectos da vida.

## Como Contribuir

Nós valorizamos e encorajamos contribuições de todos os tipos para tornar este projeto ainda melhor. Se você está interessado em contribuir, por favor, leia atentamente nossas [regras de contribuição](docs/CONTRIBUTING.md) antes de começar.

## Tecnologias Utilizadas

- Frontend: [React](https://reactjs.org/)
- Firebase: [Firebase](https://firebase.google.com/docs)

## Iniciando o Projeto

Para contribuir com o Progress Track, siga estas etapas:

1. Faça um fork deste repositório clicando no botão "Fork" no canto superior direito desta página. Isso criará uma cópia do repositório em sua conta do GitHub.

2. Clone a cópia do repositório em seu perfil na sua máquina local usando o seguinte comando:

```bash
git clone https://github.com/seu-usuario/nome-do-repositorio.git
```

3. Navegue até o diretório do projeto:

```bash
cd "nome da pasta/frontend"
```

4. Instale as dependências do projeto executando:

```bash
yarn install
```

5. Após a instalação das dependências, você pode iniciar o servidor de desenvolvimento:

```bash
yarn start
```

Isso iniciará a aplicação em modo de desenvolvimento. Abra [http://localhost:3000](http://localhost:3000) em seu navegador para visualizar o Progress Track. Agora você está pronto para começar a contribuir para o projeto!
8 changes: 8 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Contribuição

Agradecemos por considerar contribuir para o projeto! As seguintes diretrizes ajudarão você a entender como contribuir de maneira eficaz.

# Regras

- Usar Yarn: https://yarnpkg.com/
- Usar commit semântico: https://www.conventionalcommits.org/en/v1.0.0/