-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update readme and requirements file
- Loading branch information
1 parent
169fe57
commit 70c779b
Showing
2 changed files
with
21 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,39 @@ | ||
# masomo | ||
>An e-learning platform. Organise modules, courses and subjects with dynamic content between video and text. | ||
<p align="center"> | ||
<img src="https://res.cloudinary.com/dlxhllkxl/image/upload/v1674462719/Masomo_v6nnbu.png" alt="masomo" width=250> | ||
<h2 align="center">Masomo</h2> | ||
<p align="center">An e-learning platform. Organise modules, courses and subjects with dynamic content between video and text. </p> | ||
</p> | ||
|
||
## Table of Contents | ||
- [Table of Contents](#table-of-contents) | ||
- [Setting up masomo](#setting-up-masomo) | ||
- [Manual](#manual) | ||
- [Docker - it just works(WIP)](#docker---it-just-workswip) | ||
|
||
|
||
## Setting up masomo | ||
|
||
## Manual | ||
Clone the repo, install dependencies and run migrations. | ||
### Manual | ||
**Basic requirements** | ||
- memcached | ||
|
||
|
||
Install project python requirements and migrate the server | ||
```bash | ||
pip install -r requirements.txt | ||
python manage.py migrate | ||
``` | ||
|
||
Start memecache on a different terminal | ||
Start memcache on a different terminal | ||
```bash | ||
memecache -l 127.0.0.1:11211 | ||
memcached -l 127.0.0.1:11211 | ||
``` | ||
|
||
Run the project and access the components on `127.0.0.1:8000` | ||
```bash | ||
python manage.py runserver | ||
``` | ||
|
||
## Docker - it just works(WIP) | ||
### Docker - it just works(WIP) | ||
**Basic requirements** | ||
- Docker |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters