React Native Notes App

A notes app built using React native for cross-platform mobile devices.

Table of Contents

• Features
• Tools and Technologies
• Prerequisites
• Installation and setup
• Contributing
• Useful Links
• Contact

Features

User-oriented features

• Create notes
• View notes
• Update notes
• Select multiple notes
• Delete notes
• Search notes
• Sort notes
• Copy notes
• Share notes
• Clone notes
• Pin notes
• Bookmark notes
• Color notes
• Add labels to notes
• Add reminders to notes

Developer-oriented features

• Android ripple effect
• Conditional addition of property to object (JS concept)
• Custom Back button handlers
• Custom header when notes are in selected state
• Delete confirmation
• Global state for notes using React's context
• Multiple notes can be selected using "long pressing" a note (feature desirable in mobile devices)
• Persisting taps on notes while keyboard input is active
• Use of async storage library for storing notes data in user's device
• Use of React hooks
• Use of React navigation library for making multiple screens
• Use of ScrollView for scrollable components
• Use of Toast in android

Tools and Technologies

• React
• React Native
• CSS
• Eslint

Prerequisites

• Node.js
• A code editor (preferably VS Code)

Installation and Setup

1. Install all the dependencies and dev-dependencies

   npm install

2. Start the application

   npm start

3. Download expo app on the mobile device and scan the QR code generated on terminal.

4. For running on browser, press w on terminal and it will launch the browser.

Contributing

• Feature Requests:
  Want a new feature or improve already existing feature in the app? Feel free to create an issue at issue tracker about the feature you want to see in the app.

• Bug reports:
  Found a bug in the application? Feel free to create a new issue at issue tracker stating the clear description of the bug.

• Code contributions:
  Want to contribute code to the project? You can do so by either correcting bugs or adding new features which can be found in the issues tab and then submitting a Pull Request referencing that issue.

• Security vulnerabilities:
  Discovered a security vulnerability within this project? Please send an email to Aayush (author) at [email protected].

Useful Links

• This project

  • Github Repo: https://github.com/aayush301/react-native-notes-app

• Official Docs

  • Reactjs docs: https://reactjs.org/docs/getting-started.html
  • npmjs docs: https://docs.npmjs.com/
  • Github docs: https://docs.github.com/en/get-started/quickstart/hello-world

• Download links

  • Nodejs download: https://nodejs.org/
  • VS Code download: https://code.visualstudio.com/

• Cheatsheets

  • Git cheatsheet: https://education.github.com/git-cheat-sheet-education.pdf
  • VS Code keyboard shortcuts: https://code.visualstudio.com/shortcuts/keyboard-shortcuts-windows.pdf

Contact

• Email: [email protected]
• Linkedin: https://www.linkedin.com/in/aayush12/