Uma plataforma para facilitar o encontro de orfanatos por pessoas que querem visita-los.
O Layout foi disponibilizado pela rocketseat para os alunos do ignite praticarem.
-
Web
-
Backend
Esse repositório não possui um backend dedicado, tudo foi construido em cima da arquitetura proposta pelo NextJs, o que você terá que fazer para rodar é clonar o repositório, configurar as variáveis de ambiente conforme o arquivo .env.example
, rodar um yarn
e executar com yarn dev
Clone o repositório com:
> git clone https://github.com/thallesyam/happy-nextjs.git
As demonstrações utilizam YARN por padronização, mas, caso use NPM, basta substituir onde estiver escrito yarn
por npm
.
Instalando dependências do projeto web:
> cd happy-nextjs
> yarn install
Para usar o mapbox, acesse sua conta no site e crie um token para ser utilizado no projeto. Com o token em mãos, crie um arquivo .env
e coloque seu token como valor da chave NEXT_PUBLIC_ACCESS_TOKEN_MAP_BOX
.
Crie também uma conta no cloudinary e adicione ao seu .env as variáveis CLOUDINARY_NAME
, CLOUDINARY_KEY
e CLOUDINARY_SECRET
Exemplo:
NEXT_PUBLIC_ACCESS_TOKEN_MAP_BOX=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
CLOUDINARY_NAME=xxxxxxxxxxxxxxxxxxxxxx
CLOUDINARY_KEY=xxxxxxxxxxxxxxxxxxxxxx
CLOUDINARY_SECRET=xxxxxxxxxxxxxxxxxxxxxx
Agora starte o projeto em seu ambiente com:
> yarn dev
Acesse: http://localhost:3000/
para visualizar.
Siga os passos abaixo para contribuir:
-
Faça o fork do projeto (https://github.com/thallesyam/happy-nextjs)
-
Clone o seu fork para sua maquína (
git clone https://github.com/user_name/happy.git
) -
Crie uma branch para realizar sua modificação (
git checkout -b feature/name_new_feature
) -
Adicione suas modificações e faça o commit (
git commit -m "Descreva sua modificação"
) -
Push (
git push origin feature/name_new_feature
) -
Crie um novo Pull Request
-
Pronto, agora só aguardar a análise 🚀
Gostaria muito de receber a sua ajuda, esse projeto foi desenvolvido com muito carinho, e por estar aprendendo posso não ter utilizado as melhores práticas e alguns cenários, sua ajuda será mutio bem vinda, com pr's, issues ou qualquer outra ajuda.
Tenho alguns objetivos futuros para esse projeto, se estiver pensando em contribuir e estiver sem ideia pode dar uma olhada nessa lista também:
- [] Cobrir 100% do projeto com os testes
- [] Criar telas para o admin
- [] Implementar graphql ou react query ao projeto
O projeto está sobre a licença MIT ❤️
Gostou? Deixe uma estrelinha para ajudar o projeto ⭐