Skip to content

Latest commit

 

History

History
81 lines (59 loc) · 3.01 KB

README.md

File metadata and controls

81 lines (59 loc) · 3.01 KB
Raw

TakeNote

An app for developers or any person to take quick handy notes.


Table of Contents
  1. ➤ About The Project
  2. ➤ How I worked on this project?
  3. ➤ How I developed this project?
  4. ➤ Getting started
  5. ➤ Contributing guidelines
  6. ➤ License

📝 About The Project

TakeNote is an app built with React.js which can be used to take quick notes while learning or during any meetings.

How I worked?

  • My goal of the project was to work on a React App which would be based on updation of UI components as per the state changes in different scenarios. So, I developed this app to brush my skills by implementing those stuffs.
  • I have used Agile methodology to complete the whole application. I developed each segment and features of the app in small increments by implementing one thing and once and making sure it works perfectly.
  • The design inspiration was taken from takenotes.dev.

How I built this project?

  • I have used React.js frontend library for development of this app.
  • React Bootstrap Framework along with some custom CSS has been used for designing the UI of the app.
  • I have used just useState hook and Redux State Management to handle all sort of state management.
  • Search features has been implemented using the JavaScript filter method.

Getting started

This is an example of how you may give instructions on setting up your project locally.

Prerequisites

  1. Latest verion of node installed
  2. Latest version of npm installed

Installation

  1. Clone the repo

    git clone https://github.com/deepak2431/TakeNote

  2. Install NPM packages

    npm install

  3. Run npm start and the app will be served in your local environment.

Contribute to the project

  1. Choose any open issue from or request an issue.
  2. Comment on the issue: Can I work on this? and get assigned.
  3. Make changes to your fork and send a PR.

To create a PR:

Follow the given link to make a successful and valid PR: https://help.github.com/articles/creating-a-pull-request/

To send a PR, follow these rules carefully,otherwise your PR will be closed:

  1. Make PR title in this format: Fixes #IssueNo : Name of Issue

For any doubts related to the issues, i.e., to understand the issue better etc, comment down your queries on the respective issue.