Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 1.72 KB

README.md

File metadata and controls

56 lines (40 loc) · 1.72 KB

Notezy

Gitter

Notezy is an open sourced Note making webapp. image link: http://notezy.surge.sh/

Getting Started

Following instructions will fetch you a copy of the project and running on your local machine for development and testing.

Deployment

Getting Started

Following instructions will fetch you a copy of the project and running on your local machine for development and testing.

  • Fork this repository (Click the Fork button in the top right of this page, click your Profile Image)

  • Clone your fork down to your local machine

    $ git clone https://github.com/Username/Notezy.git

    For e.g:-

    $ git clone https://github.com/Melvin78/codezilla.git

    in the above example Melvin78 is the username of the user who is forking the repository.

  • Create a branch

    $ git checkout -b branch-name
  • Make your changes

  • Commit and Push

    $ git add filename 
    $ git commit -m 'commit message'
    $ git push origin branch-name
  • Create a New Pull Request from your forked repository (Click the New Pull Request button located at the top of your repo)

  • Wait for your PR review and merge approval!

  • Star this repository if you had fun!

Local Setup

  • Step 1: Cd into the cloned folder
  • Step 2: Install all the dependencies with:$ npm install
  • Step 3: Run on http://localhost:3000 with:$ npm run start
  • Step 4: Build locally with: $ npm run build
  • Step 5: To deploy at a URL use: $ npm run deploy