Sobre   |   Objetivo   |   Tecnologias e ferramentas   |   Features   |   Demonstração   |   Protótipo   |   Referência da API   |   Instalação e execução   |   Como contribuir   |   Licença

📃 Sobre

Plann.er é o projeto desenvolvido durante a trilha de React da Next Level Week Journey, um evento online produzido pela Rocketseat.

Trata-se de uma aplicação web que permite aos usuários convidar seus amigos e planejar suas próximas viagens de uma forma simples e intuitiva.

🎯 Objetivo

O objetivo principal do Plann.er é criar uma plataforma que permita aos usuários planejar suas viagens, cadastrar atividades, e links úteis para a viagem, além de poder convidar amigos para acompanhar o planejamento.

🚀 Tecnologias e ferramentas

React

TypeScript

Tailwind CSS

Vite.js

✨ Features

✅ Criação de viagens
✅ Seleção de convidados para a viagem
✅ Cadastro de atividades
✅ Validação de datas disponíveis para atividades
✅ Cadastro de links úteis
✅ Skeleton loader para carregamento de informações
✅ Design responsivo
✅ Cópia de link para a área de transferência

💻 Demonstração

plann-er-demo.webm

Criação de uma viagem:

Inclusão de convidados:

Confirmar criação de uma viagem:

Skeleton loader para as informações da viagem:

Detalhes do plano de viagem:

Cadastro de atividade:

Cadastro de link:

🎨 Protótipo

O protótipo do projeto foi desenvolvido utilizando a ferramenta Figma. Você pode acessá-lo aqui.

⚙ Referência da API

A API utilizada neste projeto foi desenvolvida pela trilha de Nodejs do NLW Journey. Você pode acessar o repositório do backend aqui.

🔗 Documentação da API base: NLW Journey Nodejs API

Nota: Para rodar o frontend em sua máquina, será necessário ter o backend rodando localmente para conexão dos recursos do banco de dados. Siga as instruções no repositório do backend para configurá-lo em sua máquina.

🔧 Instalação e execução

Para baixar o código-fonte do projeto em sua máquina, primeiramente terá que ter instalado o Git. Com o Git instalado, em seu terminal execute o seguinte comando:

git clone https://github.com/mathrb22/nlw-journey-frontend.git

Para instalar as dependências e executar o projeto terá que ter instalado em sua máquina o node.js, que vem acompanhado do npm. Instale as dependências usando o comando abaixo:

npm install

Executar o projeto:

npm run dev

A aplicação estará disponível em http://localhost:5173. Você poderá acessá-la a partir do seu navegador.

💡 Como contribuir

• Faça um fork desse repositório;
• Crie um branch para a sua feature: git checkout -b minha-feature;
• Faça um commit com suas alterações: git commit -m 'feat: Minha nova feature';
• Faça um push para o seu branch: git push origin minha-feature;
• Faça um pull request com sua feature;

Pull requests são sempre bem-vindos. Em caso de dúvidas ou sugestões, crie uma issue ou entre em contato comigo.

📝 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

---

Desenvolvido com 💚 por mathrb22