Skip to content

Latest commit

 

History

History
103 lines (80 loc) · 5.31 KB

README.md

File metadata and controls

103 lines (80 loc) · 5.31 KB
Raw

JustNotes

A simple, yet powerful notes app

GitHub forks GitHub issues David GitHub license


JustNotes lets you organize all your day to day note takings in a simple and intuitive manner. It is simple to use but sports some mighty features which will make your life easier. More than anything, you need not download another note taking app on your device as its available in your browser and also available when you are offline.

So relax, sit back, do the noting while we take care of the rest.

Getting Started

Prerequisites

You need following tools to run this project:

  • Node (>=8.6.0)
  • npm (>=5.3.0)
  • git
  • & a Web Browser

Installation

To setup this app on your local machine simply do the following:

⚠️ Warning!!
The master branch contains all recent changes and might be unstable so if you want to just try the app use the release branch.

  • Clone the repository. (Refer here if its your first time.)

  • Then run the following commands from your terminal/ git bash:

    > git clone https://github.com/UdacityMobileWebScholarship/just-notes.git
> cd just-notes
> git checkout release
> cd server
> npm install
> npm start
> cd..
> cd client
> npm install
> npm start

🎉 Congratulations!! If all went well, you should have a working copy of the app opened on your default browser. 🎉

IDE Setup

Check the following settings in your IDE:

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

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

Discussion

Join us on our slack team at #cp_notes_app.

What we work with?

Feature List

Please visit here to see the features list, features being worked on, and features completed for our app.

Design Guidelines

To start contributing please stick to our design guidelines.

Contributing

You ready to help us improve? Get started with any of the options below:

Pull Request - Bug Reports - Suggestions - Good First Issue

🔁 Pull Request

If you want to improve an existing feature or build a feature from our feature list, do the following:

  • Fork this repository. (Refer here if its your first time.)
  • Clone your forked repository to your local machine.
  • 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 (so can you too 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.

🪲 Bug Reports

To submit a bug report to us kindly check if the same issue has already been opened with us. If so, then kindly don't open another issue or else open a new thread and provide us with as much details as possible. If you feel comfortable you can even send us a Pull Request.

✏️ Suggestions

If you have a new feature idea or a way in which we can improve our app, drop us a line on our issue tracker.

#️⃣1️⃣ Good First Issue

If you don't know where to start from or have no previous experience contributing, its time to take your baby steps. Start by solving issues labeled good first issue or help wanted.



forthebadge forthebadge forthebadge