Keeper

This website aims to make an app which would help people keep a track of their notes, events and other stuff

Instructions for execution of the code

Software to be installed beforehand:

1. NodeJs
2. ReactJs

Running the application:

The website server is initiated by -
npm i
npm start
~command on git bash.

How the website is expected to look

• The website is a simple UI interface that keeps track of your quick notes.
• Users can add or remove notes from the same.
• The notes will have tags that can be used for filtering them.
• The notes may also be linked with Google Calendar API to synchronize events with the google calendar so they may act as reminders as well. Login functionality to allow personalization of the data available.
• The data would be stored on a database (perhaps MongoDB).

Note

The website is currently incomplete and has a lot of oppurtuinities for contribution and is a great way for you to get started with open source contributions!!!

The issues listed below are provided along with their difficulty levels so you may pick them accordingly!

How to contribute

• Create and Issue and wait for being assigned to it. (I shall be assigning them about twice a day)
• Fork the repository.
• Make changes and commits on the forked repository
• Create a pull request to the master branch of the original repository
• Valid pull requests will be merged

Enhancements available to do

(difficulty mentioned out of 5 and graded relatively)

• Adding a '+' button fixed on bottom right of the screen to add a new note. (2)
• Being able to delete an existing note. (2)
• Adding a NodeJS server. (2)
• Adding a login screen (only UI). (3)
• Persisting and fetching data from a database. (4)
• Making the app responsive. (2)
• Adding tags from a pre-existing list of tags to the notes. (3)
• Adding a filter button to show the notes with specific tags. (4)
• Adding or removing a tag from the list of pre-existing tags. (2)
• Adding calendar API to sync the events with the calendar and make reminders. (5)

Some of the above enhancements are dependant on other enhancements and hence you are expected to take up the issues accordingly.

PS: For the issues that I have opened already, comment in the issue to let me know if you are taking it up. (like by commenting 'I would like to take this up')

For any queries, contact me at 190030036@iitdh.ac.in. We look forward to your contributions!