Here is the website : https://notefy.servatom.com
-----------------------------------------------------
.
β
βββ frontend
β βββ public
β β βββ index.html
β β
β β
β β
β βββ src
β β βββ assets
β β β βββ css
β β β βββ media
β β βββ components
β β | βββ AddNote.js
β β | βββ Button.js
β | | βββ DashboardHome.js
β | | βββ ExpandNote.js
β β | βββ Icon.js
β | | βββ Input.js
β β | βββ Login.js
β | | βββ MoonToggle.js
β β | βββ Note.js
β | | βββ NotesList.js
β β | βββ searchbar.js
β | | βββ Settings.js
β | | βββ SideNav.js
β | | βββ ToggleBtn.js
β β |
β β βββpages
β β | βββ Auth.js
β β | βββ Dashboard.js
β β | βββ LandingPage.js
| β |
β β |
β β βββstore
β β | βββ auth-context.js
β | |
β β |
β β |
| β βββ App.js
| β βββ App.css
| β βββ index.js
| β βββ index.css
| β βββ URL.js
| β βββ CONSTANTS.js
β β |
β β |
β β |
β β |
βββ backend
β βββ config
| | βββ asgi.py
| | βββ __init__.py
β β βββ settings.py
β β βββ urls.py
β β βββ wsgi.py
β β
β β
β β
β βββ docker-compose.yml
β βββ Dockerfile
β βββ key.pem
β βββ manage.py
β |
β β
β β
β βββ notes
| | βββ apps.py
| | βββ __init__.py
β β βββ getDateTime.py
β β βββ models.py
β β βββ permissions.py
| | |ββ urls.py
β β βββ views.py
β β
β β
β β
β β
| βββ origin.pem
| |ββ requirements.txt
| |ββ run.sh
β β
β β
β βββ users
| | βββ admin.py
| | βββ forms.py
β β βββ generateAvatar.py
β β βββ __init__.py
β β βββ managers.py
| | |ββ models.py
β β βββ serializers.py
| | |ββ urls.py
β β βββ views.py
To render react-frontend, run :
$ cd frontendInstall the node modules
$ npm iNow start the react modules
$ npm startFistly, install the requirements using pipenv
$ pip install pipenv
$ pipenv install
$ pipenv shell
$ pip install -r requirements.txt$ cd backendStart the backend
$ python manage.py migrate
$ python manage.py runserver- Fork the repo
- Create a new branch (
git checkout -b improve-feature) - Make the appropriate changes in the files
- Add changes to reflect the changes made
- Commit your changes (
git commit -am 'Improve feature') - Push to the branch (
git push origin improve-feature) - Create a Pull Request
We will review and accept the PR.
If you find a bug (the website couldn't handle the query and / or gave undesired results), kindly open an issue here by including your search query and the expected result.
If you'd like to request a new function, feel free to do so by opening an issue here. Please include sample queries and their corresponding results.
-----------------------------------------------------
π All maintainers in this project are under-graduate students in the Department of
Computer Science and Engineering, TIET @ Thapar University
π© Rupanshi Jain
Email: jainrupanshi@outlook.com
GitHub: @rdotjain
π¦ Yashvardhan Arora
Email: yash22arora@gmail.com
GitHub: @yash22arora
π¦ Raghav Sharma
Email: raghav.sharma17@outlook.com
GitHub: @raghavTinker
π¦ Adamay Mann
Email: meadamann2002@gmail.com
GitHub: @mannadamay12
All contributions are welcome. Please take a moment to go through CONTRIBUTING.md
Solve the issues here
Usage is provided under the MIT License. See LICENSE for the full details.