README.md

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