/just-notes

This application is a collaborative project made by the Google Udacity Mobile Web Specialist Scholars.

Primary LanguageJavaScript

JustNotes

A simple yet powerful notes app.

Setup

Tools

You need following tools to run this project:

  • Node.js
  • npm
  • yarn
  • Web Browser

Run Locally

Setup on your local computer by following these steps:

  1. Fork the repository
  2. git clone https://github.com/<you-user-name>/just-notes.git
  3. cd just-notes
  4. npm install
  5. npm start

The latest changes will be in master branch. The deployed version of code will be in release branch.

IDE Setup

Check the following settings in your IDE:

  • editorconfig plugin is installed
  • eslint plugin if required is installed and setup

PS: Your commit might fail if you don't adhere to the coding standards. Do configure your IDE with eslint to avoid that trouble.

Contributing

Follow these steps to contribute to this repository:

  • Fork the repository
  • Clone your forked repository
  • Create a feature branch from master and work on it
  • Commit the changes to your feature branch
  • Submit a PR to the master branch of this repository
  • People in the community can review your code (And so can you for other's PRs)
  • Once approved, it will be merged with the master branch
  • On our release cycle, changes from master will be merged to release.

Raising an issue

To raise an issue, please provide us with as much detail as possible.