Skip to content

Notefy is a note-taking web app built with ReactJS and Django, with a subtle yet attractive UI and great functionality!

License

Notifications You must be signed in to change notification settings

Servatom/notefy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Logo

Notefy

Notefy is a note-taking web app built with ReactJS and Django, with a subtle yet attractive UI and great functionality!

Demo

Here is the website : https://notefy.servatom.com

Our very own note taking tool !!

Landing Page

Dashboard

Edit Notes

Settings

-----------------------------------------------------

🌡 Folder Structure

.
β”‚
β”œβ”€β”€ 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   

Want to run this repo locally?

Open your command line and start with the following commands:

To render react-frontend, run :

$ cd frontend

Install the node modules

$ npm i

Now start the react modules

$ npm start

You can run the server by:

Fistly, install the requirements using pipenv

$ pip install pipenv
$ pipenv install
$ pipenv shell
$ pip install -r requirements.txt
$ cd backend

Start the backend

$ python manage.py migrate
$ python manage.py runserver

To fix a bug or enhance an existing module, follow these steps:

Want to contribute? Great!

  • 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.

Bug / Feature Request

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.

-----------------------------------------------------

Built with

made-with-javascript


Docker

Project Motivation

Team

πŸŽ“ All maintainers in this project are under-graduate students in the Department of Computer Science and Engineering, TIET @ Thapar University

πŸ‘© Rupanshi Jain
Β Β Β Β Β  Email: [email protected]
Β Β Β Β Β  GitHub: @rdotjain

πŸ‘¦ Yashvardhan Arora
Β Β Β Β Β  Email: [email protected]
Β Β Β Β Β  GitHub: @yash22arora

πŸ‘¦ Raghav Sharma
Β Β Β Β Β  Email: [email protected]
Β Β Β Β Β  GitHub: @raghavTinker

πŸ‘¦ Adamay Mann
Β Β Β Β Β  Email: [email protected]
Β Β Β Β Β  GitHub: @mannadamay12

πŸ‘¦ Nirbhay Makhija
Β Β Β Β Β  Email: [email protected]
Β Β Β Β Β  GitHub: @Nirbhay-nrb

πŸ‘¦ Rohit Kumar
Β Β Β Β Β  Email: [email protected]
Β Β Β Β Β  GitHub: @krohitk17

Contributions

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.

About

Notefy is a note-taking web app built with ReactJS and Django, with a subtle yet attractive UI and great functionality!

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published