eduvia/lms
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: grammar correction in readme

Browse Source
This commit is contained in:
Jannat Patel
2022-12-30 18:03:01 +05:30
committed by GitHub
parent 094bd943ee
commit d82a32b06a
1 changed files with 12 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -26,20 +26,20 @@ You can create courses and lessons through simple forms. Lessons can be in the f
## Features ## Features
- Create online courses. 📚 - Create online courses. 📚
- Add detailed descriptions and preview video to the course. 🎬 - Add detailed descriptions and preview videos to the course. 🎬
- Add videos, quizzes and assignments to your lessons and make them interesting and interactive 📝 - Add videos, quizzes, and assignments to your lessons and make them interesting and interactive 📝
- Discussions section below each lesson where instructors and students can interact with each other. 💬 - Discussions section below each lesson where instructors and students can interact with each other. 💬
- Create classes to group your students based on courses and track their progress 🏛 - Create classes to group your students based on courses and track their progress 🏛
- Statistics dashboard that provides all important numbers at a glimpse. 📈 - Statistics dashboard that provides all important numbers at a glimpse. 📈
- Job Board where users can post and look for jobs. 💼 - Job Board where users can post and look for jobs. 💼
- People directory with each person's profile page 👨‍👩‍👧‍👦 - People directory with each person's profile page 👨‍👩‍👧‍👦
- Set cover image, profile photo, short bio and other professional information. 🦹🏼‍♀️ - Set cover image, profile photo, short bio, and other professional information. 🦹🏼‍♀️
- Simple layout that optimizes readability 🤓 - Simple layout that optimizes readability 🤓
- Delightful user-experience in overall usage ✨ - Delightful user experience in overall usage ✨
## Tech Stack ## Tech Stack
Frappe LMS is built on [Frappe Framework](https://frappeframework.com) which is a batteries-included python web-framework. Frappe LMS is built on [Frappe Framework](https://frappeframework.com) which is a batteries-included python web framework.
These are some of the tools it's built on: These are some of the tools it's built on:
- [Python](https://www.python.org) - [Python](https://www.python.org)
- [Redis](https://redis.io/) - [Redis](https://redis.io/)
@@ -49,23 +49,21 @@ These are some of the tools it's built on:
## Local Setup ## Local Setup
### Docker ### Docker
You need Docker, docker-compose and git setup on your machine. Refer [Docker documentation](https://docs.docker.com/). After that, run the following commands: You need Docker, docker-compose, and git setup on your machine. Refer to [Docker documentation](https://docs.docker.com/). After that, run the following commands:
``` ```
git clone https://github.com/frappe/lms git clone https://github.com/frappe/lms
cd lms/docker cd lms/docker
docker-compose up docker-compose up
``` ```
Wait for sometime until the setup script creates a site. After that you can Wait for some time until the setup script creates a site. After that, you can access `http://localhost:8000` in your browser and the app's login screen should show up.
access `http://localhost:8000` in your browser and the app's login screen
should show up.
### Frappe Bench ### Frappe Bench
Currently, this app depends on the `develop` branch of [frappe](https://github.com/frappe/frappe). Currently, this app depends on the `develop` branch of [frappe](https://github.com/frappe/frappe).
1. Setup frappe-bench by following [this guide](https://frappeframework.com/docs/v14/user/en/installation) 1. Setup frappe-bench by following [this guide](https://frappeframework.com/docs/v14/user/en/installation)
1. In the frappe-bench directory, run `bench start` and keep it running. Open a new terminal session and cd into `frappe-bench` directory. 1. In the frappe-bench directory, run `bench start` and keep it running. Open a new terminal session and cd into the `frappe-bench` directory.
1. Run the following commands: 1. Run the following commands:
```sh ```sh
bench new-site lms.test bench new-site lms.test
@@ -77,12 +75,12 @@ Currently, this app depends on the `develop` branch of [frappe](https://github.c
## Deployment ## Deployment
Frappe LMS is an app built on top of Frappe Framework. So, you can follow any deployment guide for hosting a Frappe Framework based site. Frappe LMS is an app built on top of the Frappe Framework. So, you can follow any deployment guide for hosting a Frappe Framework-based site.
### Managed Hosting ### Managed Hosting
Frappe LMS can be deployed in a few clicks on [Frappe Cloud](https://frappecloud.com/marketplace/apps/lms). Frappe LMS can be deployed in a few clicks on [Frappe Cloud](https://frappecloud.com/marketplace/apps/lms).
### Self hosting ### Self-hosting
If you want to self-host, you can follow official [Frappe Bench Installation](https://github.com/frappe/bench#installation) instructions. If you want to self-host, you can follow official [Frappe Bench Installation](https://github.com/frappe/bench#installation) instructions.
## Bugs and Feature Requests ## Bugs and Feature Requests