fix: readme and license

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

View File

@@ -0,0 +1,35 @@
**Step 1:** Clone the repo
```
$ 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
```

View File

@@ -173,9 +173,9 @@ jinja = {
## Markdown Macros for Lessons
school_markdown_macro_renderers = {
"Exercise": "school.plugins.exercise_renderer",
"Quiz": "school.plugins.quiz_renderer",
"YouTubeVideo": "school.plugins.youtube_video_renderer",
"Exercise": "school.plugins.exercise_renderer",
"Quiz": "school.plugins.quiz_renderer",
"YouTubeVideo": "school.plugins.youtube_video_renderer",
"Video": "school.plugins.video_renderer"
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 540 KiB