plann.er

The project is a complete travel itinerary platform with front-end and back-end components. Its primary goal is to simulate a system for scheduling and managing trips, offering features such as activity tracking and participant management. This project was developed during the NLW Journey, a Rocketseat event, as a way to enhance knowledge of web development using Node.js and TypeScript.

📋 Table of Contents

• About
• Table of Contents
• Features
• Application Demonstration
• Setup and Run the Application
• Technologies
• Author
• License

📝 Features

All API routes for the listed features have been fully developed and are functional. However, as this project is for educational purposes, some features were not implemented in the front-end during the course and currently have no timeline for implementation. Below is a detailed list of the features, indicating which ones have been implemented and which ones remain unavailable on the front-end.

• [x] Travel registration
• [x] Travel activity registration
• [x] Creation of travel invitations
• [x] Travel confirmation
• [x] Participant confirmation
• [x] Travel details listing
• [x] Participants listing
• [ ] Travel data update
• [ ] Manage registered guests
• [ ] Registration of important travel links
• [ ] Listing of important travel links

📲 Application Demonstration

Below, you will find example images of the application’s front-end, showcasing its main screens and highlighting its interface and core functionalities. Additionally, you can access the API documentation for detailed information about the available routes. To view the documentation, click here.

• Trip Creation

• Confirm Trip Creation

• Trip Details

• Register Trip Activity

📁 Setup and Run the Application

⚙️ Prerequisites

Before starting, you need to have the following tools installed on your machine: Git and Node.js.

It’s also recommended to use a code editor like Visual Studio Code.

🚀 How to Run the Application

Front-End Setup

```bash

Clone this repository

$ git clone https://github.com/ArturColen/plann.er.git

Navigate to the client folder

$ cd client

Install dependencies

$ npm install

Run the application in development mode

$ npm run dev

The front-end will start on port 5173 - access http://localhost:5173

```

Back-End Setup

```bash

Open a new terminal and navigate to the server folder

$ cd server

Install dependencies

$ npm install

Copy the contents of the .env.example file to a new .env file

$ cp .env.example .env

Create the database file

$ npx prisma db push

Run the server in development mode

$ npm run dev

The server will start on port 3333 - it should log Server is running on port 3333

```

💻 Technologies

The following tools and frameworks were used in the development of this project:

• Node.js: A JavaScript runtime that allows the development of scalable and high-performance server-side applications.
• TypeScript: A strongly typed programming language that builds on JavaScript, adding static types and improving code quality.
• React.js: A popular JavaScript library for building interactive and component-based user interfaces.
• Axios: A promise-based HTTP client for making API requests, with built-in support for interceptors and error handling.
• Tailwind CSS: A utility-first CSS framework for rapidly styling modern user interfaces.
• Fastify: A fast and low-overhead web framework for building APIs and back-end services in Node.js.
• Prisma: An ORM (Object-Relational Mapper) for managing database schema and queries with a focus on developer productivity.
• Nodemailer: A tool for sending emails from Node.js applications, supporting multiple transport methods.
• Day.js: A lightweight library for parsing, validating, manipulating, and formatting dates.
• Zod: A schema validation library for defining and validating the shape of data, commonly used in APIs and forms.

👨🏻‍💻 Author

|
_{Artur Bomtempo} | | :--------------------------------------------------------------------------------------------------------------------------------------------------: |

Developed by Artur Bomtempo 👋🏻. Get in touch:

📜 License

Copyright (c) 2025 Artur Bomtempo Colen

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.