Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/franklin-barbosa/nlw-journey-planer
Projeto de um site para montar planos de viagem com amigos, registrar atividades e links úteis.
https://github.com/franklin-barbosa/nlw-journey-planer
axios dayjs fastify lucide-react nodemailer prisma react-day-picker react-router reactjs tailwind-variants tailwindcss typescript zod
Last synced: 27 days ago
JSON representation
Projeto de um site para montar planos de viagem com amigos, registrar atividades e links úteis.
- Host: GitHub
- URL: https://github.com/franklin-barbosa/nlw-journey-planer
- Owner: Franklin-Barbosa
- Created: 2024-07-10T17:24:16.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-08-24T03:40:37.000Z (5 months ago)
- Last Synced: 2024-12-30T21:45:54.278Z (27 days ago)
- Topics: axios, dayjs, fastify, lucide-react, nodemailer, prisma, react-day-picker, react-router, reactjs, tailwind-variants, tailwindcss, typescript, zod
- Language: TypeScript
- Homepage:
- Size: 1.18 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Plann.er
## 💻 Sobre
**Plann.er** é um sistema de planejamento de viagens, onde você pode criar planos de viagem detalhados com seus amigos, cadastrar atividades, adicionar links úteis e muito mais. A ferramenta oferece diversas funcionalidades para facilitar a organização e tornar sua viagem ainda mais agradável.
Essa aplicação foi desenvolvida durante o evento **Next Level Week Journey** da [Rocketseat](https://www.rocketseat.com.br/) utilizando principalmente tecnologias como `Node`, `TypeScript`, `Fastify` e `React`.
## ⚙ Instalação
### 📝 Requisitos
Antes de baixar o projeto é necessário ter as seguintes ferramentas já instaladas:
* [Git](https://git-scm.com)
* [NodeJS](https://nodejs.org/en/)
* [NPM](https://www.npmjs.com/)
### Configuração
```bash
# Clone este repositório
$ git clone https://github.com/Franklin-Barbosa/NLW-JOURNEY-Planer.git
# Acesse a pasta do backend:
$ cd backend
# Instale as dependências
$ npm install
# Crie o arquivo '.env' e preencha as variáveis conforme o arquivo '.env.example'
$ .env
# Execute a aplicação em modo de desenvolvimento
$ npm run dev
# A aplicação inciará na porta 3333 que você configurou no arquivo '.env'
# Em outro terminal acesse a pasta do frontend
$ cd frontend
# Instale as dependências
$ npm install
# Execute a aplicação em modo de desenvolvimento
$ npm run dev
# A aplicação inciará na porta padrão do vite, 5173
```
### Documentação
Após o servidor backend estar rodando, é possível acessar ele através da rota `/docs` na aplicação. Caso tenha utilizado a porta padrão (3333), o endereço será: `http://localhost:3333/docs`
## 🛠 Tecnologias
### Backend
- **[TypeScript](https://www.typescriptlang.org/)**
- **[Fastify](https://fastify.dev/)**
- **[Prisma](https://www.prisma.io/)**
- **[Zod](https://zod.dev/)**
- **[Nodemailer](https://nodemailer.com/)**
- **[DayJS](https://day.js.org/)**
### Frontend
- **[React](https://react.dev/)**
- **[ReactRouter](https://reactrouter.com/en/main)**
- **[TailwindCSS](https://tailwindcss.com/)**
- **[Tailwind-Variants](https://www.tailwind-variants.org/)**
- **[React-Day-Picker](https://daypicker.dev/)**
- **[LucideReact](https://lucide.dev/guide/packages/lucide-react)**
- **[Axios](https://axios-http.com/)**
> Para mais detalhes das dependências gerais da aplicação veja os arquivos de cada componente [package.json](./backend/package.json) e [package.json](./frontend/package.json)
## ✏️ Layout do projeto
Você pode visualizar o layout do projeto através [desse link](). É necessário ter conta no [Figma](http://figma.com/) para acessá-lo.