Tech Notes is an Web application, that lets user to take notes. User can take notes, add them, edit them delete them, search them and even can share them with other users for view only, that is user can share their notes to other user to view.
- Python 3.5 or above
- Django 3.1.5
- Django Rest Framework
Create a virtual environment using pip/pip3 before installing dependencies
pip3 install virtualenv
virtualenv venv
Activate the virtual environment 'venv'
source venv/bin/activate
Install all dependency from requirements folder
pip install -r requirements.txt
settings.py
Once a database is created and connected, migrate the models
python manage.py makemigrations
python manage.py migrate
Create and configure the .env file.
Put all essential configuration in this file, like SECRET_KEY, Database credentials, Allowed hosts, etc.
Now, run the project with
python manage.py runserver
Create a superuser to get access to admin
python manage.py createsuperuser
Check the urls.py inside 'technotes' folder and navigate to the urls to view the API outputs.
- User can create account
- User can login
- User can create note
- User can update note
- User can view note
- User can see note list
- User can share note with other user
- User can see the note list that has been shared with that user
All the feature list item available in both API and Web section
User can share their note from note view page in web section