https://github.com/vwernay/nlw-journey

This is a project developed during the Next Level Week, presented by Rocketseat during July 2024.
https://github.com/vwernay/nlw-journey

axios fastify nodejs nodemailer prisma reactjs tailwindcss typescript vite zod

Last synced: 11 days ago
JSON representation

This is a project developed during the Next Level Week, presented by Rocketseat during July 2024.

• Host: GitHub
• URL: https://github.com/vwernay/nlw-journey
• Owner: vWernay
• Created: 2024-08-10T02:05:36.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-08-10T02:50:49.000Z (3 months ago)
• Last Synced: 2024-10-12T02:42:07.839Z (about 1 month ago)
• Topics: axios, fastify, nodejs, nodemailer, prisma, reactjs, tailwindcss, typescript, vite, zod
• Language: TypeScript
• Homepage:
• Size: 86.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Plann.er

**Plann.er** is a desktop application designed to help you and your friends plan trips, record activities, and save useful links. The project was developed during the NLW Journey by [Rocketseat](https://app.rocketseat.com.br/) in July 2024.

## Project Structure

The repository is divided into two main folders:

- [**frontend**](/frontend/): Contains the client-side(frontend) code.

- [**backend**](/backend/): Contains the server-side(backend) code.

## Frontend

The frontend of the Plann.er application was built using:

- **TypeScript**: A typed superset of JavaScript.

- **React**: A JavaScript library for building user interfaces.

- **TailwindCSS**: A utility-first CSS framework for styling.

- **Vite**: A fast build tool for modern web projects.

- **Axios**: A promise-based HTTP client for making requests.

- **ESLint**: A tool for identifying and fixing problems in JavaScript/TypeScript code.

## Backend

The backend of the Plann.er application was built using:

- **Node.js**: A JavaScript runtime built on Chrome's V8 engine.

- **Prisma**: An open-source database toolkit.

- **Zod**: A TypeScript-first schema declaration and validation library.

- **Fastify**: A web framework highly focused on providing the best developer experience with the least overhead.

- **TypeScript**: Ensuring type safety and code clarity.

- **Nodemailer**: A module for Node.js applications to send emails.

## Figma Design

The design for Plann.er can be found on Figma:

[Plann.er Figma Design]()

## To-Do List

- [ ] Finalize the implementation of the API communication between the frontend and backend.

- [ ] Deploy the API (backend).

- [ ] Deploy the frontend.

- [ ] Create build scripts.

## Getting Started

To get started with the project, clone this repository and navigate into the appropriate folder (`backend` or `frontend`) to install the necessary dependencies and run the application.

```bash

# Clone the repository

git clone https://github.com/vWernay/nlw-journey.git

# Navigate to the frontend

cd frontend

pnpm install

pnpm run dev

# Navigate to the backend

cd backend

pnpm install

# Copy the environment variables example file and set your own values

cp .env.example .env

# Run the backend server

pnpm run dev

```