doc: add installation docs

2023-11-16 22:19:53 +00:00
parent 00f405e3d8
commit c5aa902751
2 changed files with 100 additions and 10 deletions
@@ -16,7 +16,7 @@

 ClassroomIO is a platform for bootcamps, individual educators, and training businesses that brings teaching and learning into one place while at the same time helping them be 10x more productive. With our platform, anyone can run multiple classes and cohorts all from one UI. The application is mobile-first, which means that students can access your lesson materials from any device.

-### Mission: Provide Students with the best learning experience.
+### Mission: Provide Students with the best learning experience

 At ClassroomIO, our mission is to provide students with the best possible learning experience. We believe in empowering educators with the tools they need to deliver high-quality education that is accessible, engaging, and effective.

@@ -38,11 +38,19 @@ At ClassroomIO, our mission is to provide students with the best possible learni

 Please reach out to me on [twitter](https://x.com/rotimi_best) if you have any feature request.

+## Built With
+
+- [Svelekit](https://kit.svelte.dev/?ref=classroomio.com)
+- [Supabase](https://supabase.com/?ref=classroomio.com)
+- [TailwindCSS](https://tailwindcss.com/?ref=classroomio.com)
+
 ## Get a Demo

 You can book a quick 15 min demo to see if ClassroomIO is a good fit for you

-<a href="https://cal.com/classroomio/demo"><img src="https://cal.com/book-with-cal-dark.svg" alt="Book a Call with ClassroomIO.com"></a>
+<a href="https://cal.com/classroomio/demo">
+  <img src="https://cal.com/book-with-cal-dark.svg" alt="Book a Call with ClassroomIO.com">
+</a>

 <!-- GETTING STARTED -->

@@ -54,15 +62,95 @@ To get a local copy up and running, please follow these simple steps.

 Here is what you need to be able to run Cal.com.

- Node.js (Version: >=18.x)
- Supabase CLI
- NPM
+- [Node.js](https://nodejs.org/) (Version: >=18.x)
+- [Supabase CLI](https://github.com/supabase/cli)
+- [Docker](https://docs.docker.com/engine/install/)
+- [NPM](https://www.npmjs.com/)

-## 😍 More setup guides coming soon
+## Development

-## Useful Repos
+### Setup
+
+1. Clone the repo
+
+   ```bash
+   git clone https://github.com/rotimi-best/classroomio.git
+   ```
+
+2. Go to project folder
+
+   ```bash
+   cd classroomio
+   ```
+
+3. Setup Node If your Node version does not meet the project's requirements as instructed by the docs, "nvm" (Node Version Manager) allows using Node at the version required by the project:
+
+   ```bash
+   nvm use
+   ```
+
+   You first might need to install the specific version and then use it:
+
+   ```bash
+   nvm install && nvm use
+   ```
+
+   You can install nvm from [here](https://github.com/nvm-sh/nvm).
+
+4. Set up your `.env` file
+
+   - Duplicate `.env.example` to `.env`
+
+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/)
+   - Go to the project directory in your terminal and start supabase
+
+     ```bash
+       supabase start
+     ```
+
+   - You should get a result like this
+
+     ```bash
+       supabase local development setup is running.
+
+         API URL: http://127.0.0.1:54321
+     GraphQL URL: http://127.0.0.1:54321/graphql/v1
+           DB URL: postgresql://postgres:[email protected]:54322/postgres
+       Studio URL: http://127.0.0.1:54323
+     Inbucket URL: http://127.0.0.1:54324
+       JWT secret: super-secret-jwt-token-with-at-least-32-characters-long
+         anon key: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24iLCJleHAiOjE5ODM4MTI5OTZ9.CRXP1A7WOeoJeXxjNni43kdQwgnWNReilDMblYTn_I0
+     service_role key: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6InNlcnZpY2Vfcm9sZSIsImV4cCI6MTk4MzgxMjk5Nn0.EGIM96RAZx35lJzdJsyH-qQwv8Hdp7fsn3W0YpN81IU
+     ```
+
+   - Supabase environment variables should be taken from the result of `supabase start`
+
+     ```env
+       PUBLIC_SUPABASE_URL=<API URL>
+       PUBLIC_SUPABASE_ANON_KEY=<anon key>
+       PUBLIC_SUPABASE_BUCKET_URL=<Inbucket URL>
+     ```
+
+   - To view the Supabase studio, open the Studio URL from the result of supabase start
+
+6. Install the required dependencies
+
+   ```bash
+   npm i
+   ```
+
+7. Run (in development mode)
+
+   ```bash
+   npm run dev
+   ```
+
+## Related Repos

 You can find other repos related to classroomio here:

- Help Docs: https://github.com/rotimi-best/docs.classroomio.com
- ClassroomIO.com: https://github.com/rotimi-best/classroomio.com
+- Help Docs: <https://github.com/rotimi-best/docs.classroomio.com>
+- ClassroomIO.com: <https://github.com/rotimi-best/classroomio.com>