sticky memo

Memo pegajoso

Sticky-Memo é um aplicativo de notas pegajosas construído usando o React.js e o Vite. Esta documentação o guiará através do processo de contribuição para este projeto.

Índice

• Instalação
  • Clone o repositório
  • Instalação do front -end
• Estrutura do projeto
• Contribuindo
  • Batendo o repositório
  • Clonando o repositório
  • Criando um ramo
  • Fazendo alterações
  • Cometendo mudanças
  • Empurrando mudanças
  • Criando um pedido de tração
• Colaboradores
• Licença

Instalação

Clone o repositório

1. Gire o repositório clicando no botão "garfo" no canto superior direito da página do repositório no github.
2. Clone seu repositório bifurcado à sua máquina local:

   git clone https://github.com/your-username/Sticky-Memo.git

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

    cd Sticky-Memo

Instalação do front -end

Depois de clonar o repositório:

1. Instale as dependências :

   npm install

2. Inicie o servidor de desenvolvimento :

   npm run dev

Estrutura do projeto

Projeto

O diretório frontend contém o aplicativo React.

• public : contém os ativos públicos do aplicativo.
• src : contém o código -fonte do aplicativo.
  • components : componentes da interface do usuário reutilizáveis.
    • list of components : Lista de todos os componentes
  • pages : páginas
    • list of pages : Lista de todas as páginas
  • styles : estilo
    • list of styles : Lista de todas as folhas de estilo
  • utils
    • list of utils : Lista de todos os utilitários
• App.jsx : o componente principal que configura rotas.
• main.jsx : o ponto de entrada do aplicativo React.

Contribuindo

Congratulamo -nos com contribuições! Para contribuir com o sticky-memo, siga estas etapas:

Batendo o repositório

1. Gire o repositório clicando no botão "garfo" no canto superior direito da página do repositório no github.

Clonando o repositório

2. Clone seu repositório bifurcado à sua máquina local:

   git clone https://github.com/your-username/Sticky-Memo.git

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

    cd Sticky-Memo

Criando um ramo

4. Crie uma nova filial para o seu recurso ou correção de bug (crie uma filial de acordo com a questão que trabalha):

   git switch -c your-branch-name

Fazendo alterações

5. Faça suas alterações na base de código. Você pode editar os arquivos usando seu editor de código preferido.

Cometendo mudanças

6. Adicione as alterações à área de estadiamento:

   git add .

7. Compreenda as mudanças com uma mensagem descritiva:

   git commit -m " Description of your changes "

Empurrando mudanças

8. Empurre as mudanças no seu repositório bifurcado:

   git push origin your-branch-name

Criando um pedido de tração

9. Crie uma solicitação de tração do seu repositório bifurcado para o repositório principal. Vá para a guia "Pull Solictações" no repositório principal e clique em "Nova solicitação de puxar". Siga as instruções para criar sua solicitação de tração.

Colaboradores

Agradecemos as contribuições dos seguintes indivíduos: colaboradores

Este é apenas o começo! Estou ansioso para fazer contribuições mais significativas e colaborar com esta comunidade incrível. Vamos construir algo ótimo juntos e fazer com que o Memo Sticky seja o melhor que pode ser! ❤️?

Licença

Este projeto está licenciado sob a licença do MIT - consulte o arquivo de licença para obter detalhes.