README.md

   1 # Groove signature composer
   2
   3 This is a signature composer built for Groove.
   4 An online version is available [here](https://groove-signature-composer.netlify.com/).
   5
   6 ## Requisites
   7
   8 - Node.js v5 or superior
   9
  10 ## Getting started
  11
  12 First, in order to clone the project you can run:
  13
  14 ```shell
  15 $ git clone http://repo.or.cz/groove-signature-composer.git
  16 ```
  17
  18 Then enter into the project directory and install all dependencies.
  19
  20 ```shell
  21 $ cd groove-signature-composer
  22 $ npm install
  23 ```
  24
  25 That's it! now you can start playing with any of the available scripts
  26
  27 ## Available Scripts
  28
  29 In the project directory, you can run:
  30
  31 ### `npm start`
  32
  33 Runs the app in the development mode.<br>
  34 Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
  35
  36 The page will reload if you make edits.<br>
  37 You will also see any lint errors in the console.
  38
  39 ### `npm test`
  40
  41 Launches the test runner in the interactive watch mode.<br>
  42 See the section about [running tests](#running-tests) for more information.
  43
  44 ### `npm run build`
  45
  46 Builds the app for production to the `build` folder.<br>
  47 It correctly bundles React in production mode and optimizes the build for the best performance.
  48
  49 The build is minified and the filenames include the hashes.<br>
  50 Your app is ready to be deployed!
  51
  52 See the section about [deployment](#deployment) for more information.
  53
  54 ## Deployment
  55
  56 I'm using [Netlify](https://www.netlify.com/) to deploy the app, however the deployment
  57 just consists of uploading the files under `build/` to a server.