An open API service indexing awesome lists of open source software.

https://github.com/reinheimermat/planner-api

Project of NLW Journey event by @Rocketseat
https://github.com/reinheimermat/planner-api

backend javascript nodejs typescript

Last synced: about 2 months ago
JSON representation

Project of NLW Journey event by @Rocketseat

Awesome Lists containing this project

README

          

# Plann.er | Project of NLW Journey
[![Banner](./public/cover.jpg)](#)

With the **Plann.er**, you can create travel plans, invite friends and write down activities to perform during the trip!

> Status: Finished... ✅

## Technologies 🚀

![Node](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white)
![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
![Javascript](https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black)
![Prisma](https://img.shields.io/badge/Prisma-3982CE?style=for-the-badge&logo=Prisma&logoColor=white)
![SQLite](https://img.shields.io/badge/SQLite-07405E?style=for-the-badge&logo=sqlite&logoColor=white)
![Fastify](https://img.shields.io/badge/fastify-%23000000.svg?style=for-the-badge&logo=fastify&logoColor=white)

## Libs 📕

📑 **TSX**

📑 **DAYJS**

📑 **DOTENVT**

📑 **NODEMAILER**

## Features 💡

✅ **CREATE TRIP**

✅ **INVITE FRIENDS TO TRIP**

✅ **CREATE ACTIVITIES TO TRIP**

## How do use the project ⚙️

### Frontend

#### 1. Clone the repository
```sh
git clone https://github.com/reinheimermat/planner-web
```
#### 2. install dependencies
```sh
pnpm install
```
#### 3. Run local project
```sh
pnpm run dev
```
#### 4. Access the project
```sh
http://localhost:5173/
```
### Backend

#### 1. Clone the repository
```sh
git clone https://github.com/reinheimermat/planner-api
```
### 2. Config envoriments
Rename the file **.env.example** to **.env**

### 3. Install dependencies
```sh
pnpm run dev
```
### 4. Run create database with Prisma
```sh
npx prisma generate
```

### 5. Run the project
```sh
pnpm run dev
```

## Links 🔗

[![LinkedIn](https://img.shields.io/badge/Figma-F24E1E?style=for-the-badge&logo=figma&logoColor=white)](https://www.figma.com/community/file/1392276515495389646)

## License 📝

[![licence](https://img.shields.io/github/license/reinheimermat/discover.svg)](https://github.com/Ileriayo/markdown-badges/blob/master/LICENSE)