ulivargas/classroomio
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: chatgpt improvement to README

Browse Source
This commit is contained in:
Rotimi Best
2023-11-24 21:45:51 +00:00
committed by GitHub
parent b94435b121
commit 03ca379094
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+11 -11
View File
@@ -1,8 +1,8 @@
<a href="https://classroomio.com/">
<img alt="Spend less time doing the boring stuffs, instead focus on impacting the lives of your students." src="https://classroomio.com/classroomio-opengraph-image.png" />
<img alt="Spend less time on the boring stuff, and instead focus on impacting the lives of your students." src="https://classroomio.com/classroomio-opengraph-image.png" />
<h1 align="center">ClassroomIO</h1>
<p align="center">
The Open Source Teaching Platform for Bootcamps
The Open Source Teaching Platform for Tech Bootcamps
<br />
<a href="https://classroomio.com">Website</a> | <a href="https://dub.sh/ciodiscord">Join Discord community</a>
</p>
@@ -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.
@@ -28,12 +28,12 @@ At ClassroomIO, our mission is to provide students with the best possible learni
4. **💬 Forum:** Students can ask questions in your dedicated community and get answers from either you or other students.
5. **🏆 Kahoot-Like Quiz:** You can create live quizzes to create more engagement in your classrooms.
6. **💻 Dedicated Student Dashboard:** Once you create an account, you get a dedicated dashboard where your students can access all their courses, assignments, and more.
7. **🔒 Fully open source:** You can self-hostable the whole stack on your servers.
7. **🔒 Fully open source:** You can self-host the entire stack on your servers.
### Roadmap Features
1. **Forms:** Instead of using Google Forms to collect vital information from your students, you will be able to create forms directly within the dashboard.
2. **Course Announcement:** You can make public announcements from the course dashboard to all your students.
2. **Course Announcement:** You can send public announcements from the course dashboard to all your students.
3. **Course Templates:** You can clone a full course or share templates with other people.
4. **Analytics:** You can track data about your students across multiple courses.
5. **Run Courses on Messengers:** Students can just join a channel on slack/discord/telegram and a bot automatically sends daily lesson content to your students without you doing anything.
@@ -62,7 +62,7 @@ To get a local copy up and running, please follow these simple steps.
### Prerequisites
Here is what you need to be able to run Cal.com.
Here is what you need to be able to run ClassroomIO.com
- [Node.js](https://nodejs.org/) (Version: >=18.x)
- [Supabase CLI](https://github.com/supabase/cli)
@@ -85,7 +85,7 @@ Here is what you need to be able to run Cal.com.
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:
3. Set up Node if your Node version does not meet the project's requirements, as instructed by the documentation., "nvm" (Node Version Manager) allows using Node at the version required by the project:
```bash
nvm use
@@ -101,13 +101,13 @@ Here is what you need to be able to run Cal.com.
4. Set up your `.env` file
- Duplicate `.env.example` to `.env`
- Duplicate the `.env.example` file and rename it to `.env`
5. Setup Supabase.
- Make sure you've downloaded the [supabase cli](https://github.com/supabase/cli)
- 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
- Go to the project directory in your terminal and start Supabase
```bash
supabase start
@@ -136,7 +136,7 @@ Here is what you need to be able to run Cal.com.
PUBLIC_SUPABASE_BUCKET_URL=<Inbucket 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 `supabase start`
6. Install the required dependencies