diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7f5b5b2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.idea/* +*.pyc +*.sqlite3 +account/migrations/* +notes/migrations/* \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..637d8bd --- /dev/null +++ b/README.md @@ -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://www.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) diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..eaecb51 --- /dev/null +++ b/requirements.txt @@ -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 \ No newline at end of file