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

Usage

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

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

Contributions

All contributions are welcome. Please take a moment to go through CONTRIBUTING.md

Solve the issues here

License

Usage is provided under the MIT License. See LICENSE for the full details.

raghavtinker / notefy Goto Github PK

notefy's Introduction