Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (34 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

54 lines (34 loc) · 1.08 KB

Contributing Guidelines

Thank you for considering contributing to Relaunch project! We appreciate your help in making this project better. Below are the guidelines to help you get started.

Clone the Repository

Clone the repository to your local machine:

Start Generation Here

git clone https://github.com/your-username/relaunch.git
cd relaunch

Setting Up the Project Locally

To set up this project on your local machine, please follow these steps:

Prerequisites

  1. Node.js: Ensure you have Node.js installed. You can download it from nodejs.org.

  2. Yarn: This project uses Yarn as a package manager. Install it globally if you haven't already:

    npm install --global yarn

  3. Turso: You will need a Turso database. Sign up at turso.io and create a new database.

Install dependencies

pnpm install

Set up environment variables

cp .env.example .env

Run database migrations

pnpm db:migrate

Start the development server

pnpm dev