Curate - A Playlist Sharing Platform

Table of Contents

1. Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Resources

Built With

• React (TypeScript Vite)
• Tailwind CSS
• NodeJS/Express (TypeScript)
• Prisma
• MySQL

(back to top)

Getting Started

Prerequisites

• Node (Version 16+)
• NPM (Version 8+)
• Python (Version 3.9+)

Installation

Install all the required packages in the client and server directory

cd client && npm i

cd server && npm i

Install the Python packages from requirements.txt

pip install -r requirements.txt

Install wkhtmltopdf (which the pdfkit Python package uses)

sudo apt install wkhtmltopdf

(back to top)

Usage

To run the project locally

Prerequisites

Client

1. Create a .env file in the /client directory
2. Add the following to the .env file

VITE_SERVER_URL={SERVER_URL}/api
VITE_SECRET_KEY={32 characters long base64 string}

Where the SERVER_URL is the address to the server, either http://localhost:3300 or YOUR_IP:3300 or any other port you desire.

You can use this Base64 String Generator to generate the secret key.

Server

1. Create a .env file in the /server directory
2. Add the following to the .env file

DATABASE_URL="mysql://USER:PASSWORD@HOST:PORT/DATABASE"

Refer to the Prisma Documentation regarding connection strings.

Running both client and server simultaneously

1. Run the command npm run dev at the root directory

Running client and server independently

Client

1. Run the client by running npm run dev in the /client directory

Server

1. Run the server by running npm run dev in the /server directory

(back to top)

Resources

• Database Schema

(back to top)