Skip to content

muremwa/notes-world

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

notes world

This is a website for users to create notes, work on them, collaborate with friends(other users).
The site is served here.

made in Django 2.0

requires python 3.x

Note the frontend requires Bootstrap framework 5.x and ReactJs

dropped use of JQuery.


Features

  1. User can sign up or sign in.
  2. Users can send, accept or deny connection requests from other users just like facebook friend requests or LinkedIn connections.
  3. User can create notes in Markdown.
  4. Users can add their connections to collaborate on notes
  5. Users receive notifications for comments or replies they're mentioned in, when they get requests, when their requests are accepted and when they are added as collaborators to a note.
  6. Notes are either private (only the owner can see it), connected (only your connections can see them) and Public (anyone can see them).
  7. A note being for connected users does not mean others can edit it. It has to be collaborative.
  8. The comment section is made in ReactJS. The source code of the comment section can be found here.
  9. You can mention a user in the comment sections using @username for them to receive a notification.
  10. You can edit and delete your own comments.
  11. A note user can delete comments they don't like no matter the owner of the comment.

The source code of the comment section can be found here.


getting started

  1. Clone the repo

        git clone https://github.com/muremwa/notes-world.git
  2. Install the requirements

        pip install requirements.txt
  3. Make migrations

        python manage.py makemigrations notes
        python manage.py makemigrations account
        python manage.py makemigrations notifications
        python manage.py migrate
  4. Run Local server

        python manage.py runserver
  5. Browse

    Using your browser navigate to your local server at port 8000