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

fix: readme and license

Browse Source
This commit is contained in:
Jannat Patel
2021-10-27 20:00:07 +05:30
parent 857f170034
commit a650a31990
6 changed files with 719 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
README.md
View File

@@ -1,71 +1,20 @@
## School
This app helps people organize and manage their own communities.
Create online courses without much hassle.
The App has following components:
![Course Home](/school/public/images/course-home.png)
1. Hackathons
1. LMS
School is built on the [Frappe Framework](https://github.com/frappe/frappe), a full-stack web app framework built with Python & JavaScript.
1. Create online courses in a simple manner
1. The UI is clean and minimal
1. Lessons can be in the form of texts, videos, quizzes or a combination of all of these.
## Development Setup
**Step 1:** Clone the repo
1. [Through Docker](docker-installation.md)
1. [Direct install through bench](bench-installation.md)
```
$ git clone https://github.com/frappe/school.git
$ cd school
```
**Step 2:** Run docker-compose
```
$ docker-compose up
```
**Step 3:** Visit the website at http://localhost:8000/
You'll have to go through the setup wizard to setup the website for the first time you access it. Login using the following credentiasl to complete the setup wizard.
```
Username: Administrator
password: admin
```
TODO: Explain how to load sample data
## Stopping the server
Press `ctrl+c` in the terminal to stop the server. You can also run `docker-compose down` in another terminal to stop it.
To completely reset the instance, do the following:
```
$ docker-compose down --volumes
$ docker-compose up
```
## Making Code Changes
The dev setup is configured to reload whenever any code is changed. Just edit the code and reload the webpage.
Commit the changes in a branch and send a pull request.
## Local Setup - The Hard Way
To setup the repository locally follow the steps mentioned below:
1. Install bench and setup a frappe-bench directory by following the [Installation Steps](https://frappeframework.com/docs/user/en/installation).
1. Start the server by running bench start.
1. In a separate terminal window, create a new site by running bench new-site school.test.
1. Run bench get-app https://github.com/frappe/school.
1. Run bench --site school.test install-app school.
1. Map your site to localhost with the command ```bench --site school.test add-to-hosts```
1. Now open the URL http://school.test:8000/ in your browser, you should see the app running.
### Contribution Guidelines (for The Hard Way)
### Contribution Guidelines
1. Go to the apps/school directory of your installation and execute git pull --unshallow to ensure that you have the full git repository. Also fork the frappe/school repository on GitHub.
1. Check out a working branch in git (e.g. git checkout -b my-new-branch).
@@ -74,6 +23,6 @@ To setup the repository locally follow the steps mentioned below:
1. Commit your changes to your branch. Make sure to use a semantic commit message.
1. Push your branch to your fork on Github, and issue a pull request.
#### License
## License
AGPL
[GNU AFFERO GENERAL PUBLIC LICENSE](license.txt)