diff --git a/README.md b/README.md index c3255f39..e1a12e6d 100644 --- a/README.md +++ b/README.md @@ -81,7 +81,7 @@ This repo is a mono repo that consists of 3 projects: ### Setup -1. Clone the repo +1. Fork the repo, then clone it using the following command (remember to replace the url with the url from your forked repo) ```bash git clone https://github.com/rotimi-best/classroomio.git @@ -107,19 +107,21 @@ This repo is a mono repo that consists of 3 projects: You can install nvm from [here](https://github.com/nvm-sh/nvm). -4. Set up your `.env` file + You also need to have pnpm installed, you can find the installation guide [here](https://pnpm.io/installation#using-npm) + +5. Set up your `.env` file - Go to `apps/classroomio-com` and `apps/dashboard` - Duplicate the `.env.example` file and rename it to `.env` -5. Setup Supabase. +6. Setup Supabase. - Make sure you've downloaded the [Supabase cli](https://github.com/supabase/cli) - Install and Start [docker](https://docs.docker.com/engine/install/) - Go to the project directory in your terminal and start Supabase ```bash - supabase start + pnpm supabase start ``` - You should get a result like this @@ -137,7 +139,7 @@ This repo is a mono repo that consists of 3 projects: service_role key: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6InNlcnZpY2Vfcm9sZSIsImV4cCI6MTk4MzgxMjk5Nn0.EGIM96RAZx35lJzdJsyH-qQwv8Hdp7fsn3W0YpN81IU ``` - - Add Supabase environment variables into `app/dashboard` folder, which should be taken from the result of `supabase start` + - Add Supabase environment variables into `app/dashboard` folder, which should be taken from the result of `pnpm supabase start` ```env PUBLIC_SUPABASE_URL= @@ -145,26 +147,26 @@ This repo is a mono repo that consists of 3 projects: PUBLIC_SUPABASE_BUCKET_URL= ``` - - To view the Supabase studio, open the Studio URL from the result of `supabase start` + - To view the Supabase studio, open the Studio URL from the result of `pnpm supabase start` -6. Install the required dependencies +7. Install the required dependencies ```bash pnpm i ``` -7. Run all projects (in development mode) +8. Run all projects (in development mode) ```bash pnpm dev ``` -8. All projects should start running +9. All projects should start running - `classroomio-com`: [http://localhost:5173](http://localhost:5173) - `dashboard`: [http://localhost:5174](http://localhost:5174) - `docs`: [http://localhost:3000](http://localhost:3000) -9. Running a specific project +10. Running a specific project - **classroomio-com**: `pnpm dev --filter=classroomio-com` - **dashboard**: `pnpm dev --filter=dashboard` - **docs**: `pnpm dev --filter=docs` diff --git a/package.json b/package.json index aeb50e36..e1d98a26 100644 --- a/package.json +++ b/package.json @@ -16,8 +16,9 @@ "prettier": "^3.1.0", "prettier-plugin-svelte": "^3.1.2", "prettier-plugin-tailwindcss": "^0.5.7", + "supabase": "^1.112.0", + "tsconfig": "workspace:*", "turbo": "^1.10.16", - "typescript": "^5.1.6", - "tsconfig": "workspace:*" + "typescript": "^5.1.6" } } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index ea342289..29e828f6 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -20,6 +20,9 @@ importers: prettier-plugin-tailwindcss: specifier: ^0.5.7 version: 0.5.7(prettier-plugin-svelte@3.1.2)(prettier@3.1.0) + supabase: + specifier: ^1.112.0 + version: 1.112.0 tsconfig: specifier: workspace:* version: link:packages/tsconfig