Skip to content

Commit

Permalink
docs: update readme and requirements file
Browse files Browse the repository at this point in the history
  • Loading branch information
MarvinKweyu committed Jan 26, 2023
1 parent 169fe57 commit 70c779b
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 7 deletions.
27 changes: 20 additions & 7 deletions README.md
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
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ mypy-extensions==0.4.3
pathspec==0.10.3
Pillow==9.4.0
platformdirs==2.6.2
pymemcache==4.0.0
python-memcached==1.59
pytz==2022.7.1
requests==2.28.1
Expand Down

0 comments on commit 70c779b

Please sign in to comment.