Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ssoaresleo/nlw-plann-er-web
A desktop application for creating travel plans for work or vacations with friends.
https://github.com/ssoaresleo/nlw-plann-er-web
nlw-jorney nlw-journey-react react rocketseat typescript vite
Last synced: about 15 hours ago
JSON representation
A desktop application for creating travel plans for work or vacations with friends.
- Host: GitHub
- URL: https://github.com/ssoaresleo/nlw-plann-er-web
- Owner: ssoaresleo
- License: mit
- Created: 2024-07-12T14:21:10.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-07-23T14:09:35.000Z (2 months ago)
- Last Synced: 2024-09-20T11:37:09.364Z (5 days ago)
- Topics: nlw-jorney, nlw-journey-react, react, rocketseat, typescript, vite
- Language: TypeScript
- Homepage:
- Size: 468 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Plann.er
## Topics
- [Stacks](#stacks)
- [About](#about)
- [How to Use](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)
## About
A desktop application for creating travel plans for work or vacations with friends, registering activities, adding important links, and inviting new participants. This project was developed during Rocketseat's NLW event in the React track.
## Stacks
- React
- TypeScript
- Tailwind
- Zod
- React Hook Form
## Features
- Create a trip
- Add guests
- Add activities to the trip
- Add important links to the trip
- Add more guests to the trip
- Update trip destination and date
## Getting Started
To run the Planner application locally, follow these steps.
### Prerequisites
To run the application, you need to clone the backend repository as well. You can find the backend repository at the following link:
```sh
git clone https://github.com/ssoaresleo/nlw-journey-rocketseat
```
### Installation
Before running the application, you need to set up both the frontend and backend environments:
### Frontend
Download the frontend source code.
1. Clone the repo
```sh
git clone https://github.com/ssoaresleo/nlw-plann-er-web
```
2. Install NPM packages
```sh
npm install
```
3. Start the development server to run the application in development mode.
```sh
npm run dev
```
### Backend
Assuming you have already cloned the backend repository, follow these steps to set it up.
1. Install NPM packages
```sh
npm install
```
2. Start the backend using Docker
```sh
docker-compose up
```
## Usage
Here are some examples of how to use the application after configuration
### Creating a Trip
#### Step 1
To create a trip, the first step is to choose the destination, start date, and end date of the trip. This information helps in organizing and planning the itinerary effectively.
#### Step 2
In this step, you can enter multiple email addresses of people you want to invite to join the trip. They will receive invitations to collaborate and plan together.
### Step 3
Confirm the trip details by providing the owner's name and email address for final confirmation. The owner will receive an email to confirm the creation of the trip. After confirmation, they will be redirected to a screen displaying trip details. Confirmation emails will also be sent to participants, informing them about the trip.
**Note:** Confirmation emails for participants will appear in the terminal of the backend.
## Trip Details
Here is an example of the Trip Details screen, where users can view all the information related to a specific trip. This screen typically includes details such as destination, dates, invited guests, activities planned, and important links.
## Participant Confirmation
Here is an example of the Participant Confirmation screen. When invited to join a trip, participants receive an email with a link to confirm their participation.
This section demonstrates how participants interact with the invitation confirmation process in your application.
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Developers
[
Leonardo Henrique](https://github.com/ssoaresleo)