Skip to content

Latest commit

 

History

History
125 lines (89 loc) · 6.49 KB

README.md

File metadata and controls

125 lines (89 loc) · 6.49 KB
Raw

Portal Estágio

Disponível em https://portalestagio.com/.

Atualmente o projeto encontra-se em um estágio inicial, com poucas funcionalidades implementadas. Caso queira contribuir, consulte a seção como contribuir.

Sobre o Projeto

Este projeto é um web app para conectar empresas que oferecem estágios e candidatos que procuram oportunidades, feito através do grupo Os Programadores.

As empresas podem cadastrar as suas vagas e os candidatos podem se candidatar a elas.

Como Contribuir

Agradecemos o seu interesse em contribuir para o Portal De Estágios!

Este é um projeto open source e todas as contribuições são bem-vindas!.

Aqui estão algumas maneiras de contribuir:

  1. Grupo Os Programadores:

    1. As discussões sobre esse projeto estão sendo feita através do grupo Os Programadores, no Telegram.
    2. O site oficial do grupo é https://osprogramadores.com/.
    3. Adicionalmente você pode contribuir com as discussões em andamento nas issues/discussões abertas.
    4. Caso não encontre o tópico da discussão que deseja, crie uma issue ou discussão sobre o tópico.

  2. Contribuir com o código:

    1. Faça um fork do projeto, caso ainda não tenha um;
    2. Crie uma branch;
    3. Faça as suas alterações (não esqueça de commitar as mudanças para o seu repositório!);
    4. Abra um Pull Request para dar um merge com as suas modificações.
      1. Se houver uma issue associada as suas mudanças, mencione-a no seu PR.
      2. Descreva o que foi modificado e o porquê no seu PR, isso facilitará o processo de revisão.

Caso precise de um guia de estudos, recomendamos a leitura deste guia.

Para conferir as issues e as discussões em andamento você pode acessá-las diretamente através das suas respectivas abas no topo desta página.

Licença

Este projeto utiliza a licença GNU LGPL v3. Uma cópia da licença, em inglês, está disponível em LICENSE.md.

Executando a aplicação

A aplicação está sendo criada usando NextJS.

Requisitos:

  • Node.js 18.17, ou mais recente, precisa estar instalado na sua máquina.
    • Recomendamos instalar as versões LTS
Comando para iniciar a aplicação em modo desenvolvimento:
npm run dev

Siga as instruções exibidas na linha de comando para acessar a aplicação no navegador padrão do seu computador.

Lembrando que, caso você não tenha instalado as dependências do projeto o comando acima falhará!

Para conferir se ainda há alguma dependência que não foi instalada execute o comando npm list. Se a saída do comando apresentar mensagens de erro, você precisa instalá-las.

Para instalar as dependências do projeto, execute o seguinte comando:

npm install

Gerenciamento de versões do Node

Para instalar e gerenciar diferentes versões do node.js você pode usar as seguintes ferramentas:

  • Caso você utilize Linux, pode utilizar o nvm
  • Caso você utilize Windows, pode utilizar o nvm-windows

Ambos são ferramentas amplamente utilizadas e difundidas para facilitar a instalação/manutenção do Node.

Informações sobre como instalá-las estão disponíveis nos seus respectivos repositórios.

Caso tenha dificuldades nesta etapa, peça ajuda no grupo Os Programadores, no Telegram.

Usando o Git e o GitHub

Se você é novo no Git e no GitHub, aqui estão alguns passos para começar:

  1. Fork do Repositório:
    1. No canto superior direito da página do repositório, clique no botão "Fork".
  2. Clone o Repositório:
    1. No seu repositório forkado, clique no botão "Code" e copie a URL do seu repositório.
    2. Abra seu terminal e navege até a pasta onde deseja clonar o repositório.
    3. Digite o comando git clone url substituindo url pela URL do seu repositório que você copiou no item 2.i.
      1. Exemplo: git clone https://github.com/OsProgramadores/portalestagio.git
  3. Crie uma nova Branch:
    1. Existem algumas formas para se criar uma nova branch. Você pode fazer isso pelo seu terminal com os seguintes comandos:
      1. git checkout -b nome-da-branch
      2. git switch -c nome-da-branch
    2. Em ambos os comandos você deve substituir nome-da-branch pelo nome que deseja dar ao seu branch.
  4. Faça suas alterações:
    1. Adicione, edite ou delete arquivos conforme necessário.
  5. Salvando suas alterações:
    1. Após ter salvo as suas alterações, você precisa adicioná-las ao repositório. Para fazer isso você precisa adicionar as mudanças/inserções/remoções dos arquivos ao git.
    2. Em um terminal, no repositório onde você fez as alterações, digite o comando git status.
    3. O resultado deste comando deve-lhe informar sobre as modificações feitas no repositório e o que está pendente para ser enviado.
    4. Adicione as modificações necessárias utilizando o comando git add arquivo, onde arquivo é o nome do arquivo com o caminho para ele.
      1. Alternativamente você pode adicionar um diretório inteiro repassando o caminho para o diretório no lugar do arquivo.
      2. Para adicionar o diretório atual você pode usar o comando git add .
    5. Confira se todos os arquivos necessários foram adicionados.
    6. Uma vez que você tenha adicionado os arquivos necessários, agora é hora de gerar um novo commit para salvar suas modificações.
    7. Você pode fazer isso usando o comandogit commit -m "sua mensagem de commit", alterando "mensagem de commit" por algo que explique suas alterações.
  6. Enviando suas alterações para o GitHub:
    1. Após ter criado o commit, você precisa enviar as suas alterações para o GitHub.
    2. Você pode fazer isso utilizando o comando git push --set-upstream origin nome_da_sua_branch.
  7. Abrindo um Pull Request:
    1. Após você ter enviado as suas alterações, volte para a página do seu repositório forkado no GitHub.
    2. Um botão Compare & pull request deverá ser exibido. Clique nele para criar seu PR (Pull Request).
    3. Escreva uma descrição das suas alterações e clique no botão "Create pull request".
    4. Aguarde o processo de revisão do seu PR.