feat: gitpod setup (#91)
* Add setup tasks for gitpod * chore: updating image name * chore: update image to workspace-full * chore: update all instances of workspace:* to file:* * chore: remove workspaces section on package.json * chore: update supabase command to use npx * chore: update gitpod file to use brew to install supabase cli * revert: all instances of file:* to workspace:* * chore: consolidate tasks into two steps * chore: update main to command * Update 20231115082347_remote_schema.sql * check if column exists before creating * Update .gitpod.yml with Supabase setup and project start commands * docs: add gitpod setup to readme * combine all commands * enable gitpod prebuild * remove gitpod prebuild & move dep setup to init * add prebuilds back to config * complete setup gitpod instructions * docs: add docs for gitpod setup --------- Co-authored-by: Obakeng <60041842+obakeng-develops@users.noreply.github.com>
This commit is contained in:
@@ -79,7 +79,15 @@ This repo is a mono repo that consists of 3 projects:
|
||||
|
||||
## Development
|
||||
|
||||
### Setup
|
||||
### Gitpod Setup
|
||||
|
||||
1. Click the button below to open this project in Gitpod.
|
||||
|
||||
2. This will open a fully configured workspace in your browser with all the necessary dependencies already installed.
|
||||
|
||||
[](https://gitpod.io/#https://github.com/rotimi-best/classroomio)
|
||||
|
||||
### Local Setup
|
||||
|
||||
1. Fork the repo, then clone it using the following command (remember to replace the url with the url from your forked repo)
|
||||
|
||||
@@ -109,12 +117,12 @@ This repo is a mono repo that consists of 3 projects:
|
||||
|
||||
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
|
||||
4. Set up your `.env` file
|
||||
|
||||
- Go to `apps/classroomio-com` and `apps/dashboard`
|
||||
- Duplicate the `.env.example` file and rename it to `.env`
|
||||
|
||||
6. Setup Supabase.
|
||||
5. 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/)
|
||||
@@ -149,24 +157,25 @@ This repo is a mono repo that consists of 3 projects:
|
||||
|
||||
- To view the Supabase studio, open the Studio URL from the result of `pnpm supabase start`
|
||||
|
||||
7. Install the required dependencies
|
||||
6. Install the required dependencies
|
||||
|
||||
```bash
|
||||
pnpm i
|
||||
```
|
||||
|
||||
8. Run all projects (in development mode)
|
||||
7. Run all projects (in development mode)
|
||||
|
||||
```bash
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
9. All projects should start running
|
||||
8. 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)
|
||||
|
||||
10. Running a specific project
|
||||
9. Running a specific project
|
||||
- **classroomio-com**: `pnpm dev --filter=classroomio-com`
|
||||
- **dashboard**: `pnpm dev --filter=dashboard`
|
||||
- **docs**: `pnpm dev --filter=docs`
|
||||
- **docs**: `pnpm dev --filter=docs`
|
||||
|
||||
Reference in New Issue
Block a user