Varaamo is the user interface for the City of Helsinki resource reservation service.
JavaScript CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
config
server
.babelrc
.editorconfig
.eslintignore
.eslintrc
.gitignore
.npmrc
.travis.yml
LICENSE
README.md
package.json

README.md

Varaamo

Build status codecov

User interface for the City of Helsinki varaamo.hel.fi resource reservation service. Uses the respa API.

Requirements

Architecture

  • Redux handles the state management of the app. For more info check their awesome docs.
  • React handles the rendering of the 'views'.
  • react-redux is used to connect the Redux Store to React components.
  • react-router handles the routing of the app.
  • reselect is used for getting data from Redux Store and manipulating it to be better usable in React components.
  • redux-api-middleware is used to interact with the API.
  • The application is run on an express server.
  • Uses Passport and Passport-Helsinki for authentication.
  • webpack takes modules with dependencies and generates static assets representing those modules.
  • Babel transforms JavaScript written in ES2015 and JSX syntax to regular JavaScript.

Usage

Starting development server

Follow the instructions below to set up the development environment. By default the running app can be found at localhost:3000.

  1. Install npm dependencies:

    $ npm install
    
  2. Make sure you have the following env variables set in an .env file in the root of the project:

    API_URL
    CLIENT_ID
    CLIENT_SECRET
    SESSION_SECRET
    TARGET_APP
    
  3. Then, start the development server:

    $ npm start
    

Starting production server

Follow the instructions below to build and start production server. By default the running app uses port 8080.

  1. Install npm dependencies:

    $ npm install
    
  2. Build the production bundle:

    $ npm run build
    
  3. Make sure you have the required env variables set.

  4. Then, start the production server:

    $ npm run start:production
    

Running tests

  • Run tests:

    $ npm test
    
  • Run tests in watch mode:

    $ npm run test:watch
    
  • Run tests with coverage:

    $ npm run test:coverage
    

Running code linter

  • To check the code for linting errors:

    $ npm run lint
    

Code style and linting

The code mostly follows the Airbnb JavaScript Style Guide. All JavaScript should be written in ES2015 syntax. Code is automatically linted with eslint when running unit tests or bundling the app with webpack.

Styles and Stylesheets

Less CSS pre-processor is used to make writing styles nicer. Autoprefixer handles CSS vendor prefixes. Bootstrap is used as the CSS framework for the site and City of Helsinki Bootstrap theme is used as the main theme.

Testing framework

  • Karma is used to run the tests. On local machines tests are run on PhantomJS to make running tests in watch mode as smooth as possible. On CI the tests are run on Chrome.
  • Mocha is used as the test framework.
  • Chai is used for test assertions.
  • simple-mock and MockDate are used for mocking and spies.
  • Enzyme is used to make testing React Components easier.

License

The MIT License

Copyright (c) 2015 City of Helsinki <http://www.hel.fi/>