Skip to content

Commit

Permalink
added requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
muremwa committed Sep 3, 2018
1 parent 9c97f08 commit 91157d1
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.idea/*
*.pyc
*.sqlite3
account/migrations/*
notes/migrations/*
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# notes world
This is a website for users to create notes, work on them, collaborate with friends(other users)

made in [**Django 2.0**](https://djangoproject.com "Django website")

> **requires python 3.x**
**Note**
the frontend requires [**Bootstrap framework**](http://getbootstrap.com "Bootstrap wesite") 4.x and [JQuery](http://jquery.com "JQuery website")

## getting started

1. Clone the repo
```bash
git clone https://github.com/muremwa/notes-world
```

2. Install the requirements
```bash
pip install requirements.txt
```

3. Make migartions
```bash
python manage.py makemigartions notes
python manage.py makemigartions account
python manage.py migrate
```

4. Run Local server
```bash
python manage.py runserver
```

5. Browse

Psing your browser navigate to your local server at [port 8000](http://127.0.0.1:8000)
7 changes: 7 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Django==2.0.6
django-bootstrap-form==3.4
django-markdown-deux==1.0.5
django-pagedown==1.0.5
django-widget-tweaks==1.4.2
markdown2==2.3.5
Pillow==5.1.0

0 comments on commit 91157d1

Please # to comment.