Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/city-of-helsinki/tilapankki
User interface for the City of Helsinki Stadin Tilapankki resource reservation service
https://github.com/city-of-helsinki/tilapankki
Last synced: about 2 months ago
JSON representation
User interface for the City of Helsinki Stadin Tilapankki resource reservation service
- Host: GitHub
- URL: https://github.com/city-of-helsinki/tilapankki
- Owner: City-of-Helsinki
- Created: 2017-04-07T12:16:53.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-11-15T23:59:14.000Z (about 1 year ago)
- Last Synced: 2024-04-08T16:43:03.960Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 1.47 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Respa-ui
========
[](https://travis-ci.org/City-of-Helsinki/tilapankki)
[](https://codecov.io/gh/City-of-Helsinki/tilapankki)
User interface for the City of Helsinki [varaamo.hel.fi](https://varaamo.hel.fi/) resource reservation service. Uses the [respa API](http://api.hel.fi/respa/v1/).
Requirements
------------
- [node](http://nodejs.org/) `^0.12.7`
- [npm](https://www.npmjs.com/) `^2.14.11`
Architecture
------------
- [Redux](https://github.com/rackt/redux) handles the state management of the app. For more info check their awesome [docs](http://rackt.org/redux/index.html).
- [React](https://facebook.github.io/react/) handles the rendering of the 'views'.
- [react-redux](https://github.com/rackt/react-redux) is used to connect the Redux Store to React components.
- [react-router](https://github.com/rackt/react-router) handles the routing of the app.
- [reselect](https://github.com/rackt/reselect) is used for getting data from Redux Store and manipulating it to be better usable in React components.
- [redux-api-middleware](https://github.com/agraboso/redux-api-middleware) is used to interact with the API.
- The application is run on an [express](http://expressjs.com/) server.
- Uses [Passport](https://github.com/jaredhanson/passport) and [Passport-Helsinki](https://github.com/City-of-Helsinki/passport-helsinki) for authentication.
- [webpack](https://webpack.github.io/) takes modules with dependencies and generates static assets representing those modules.
- [Babel](https://babeljs.io/) 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. Set correct environment variables for passport authentication.
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. Set correct environment variables for passport authentication.
4. Then, start the production server:
```
$ npm run start:production
```
### 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](https://github.com/airbnb/javascript).
All JavaScript should be written in ES2015 syntax.
Code is automatically linted with [eslint](http://eslint.org/) when running unit tests or bundling the app with webpack.
Styles and Stylesheets
----------------------
[Less](http://lesscss.org/) CSS pre-processor is used to make writing styles nicer. [Autoprefixer](https://github.com/postcss/autoprefixer) handles CSS vendor prefixes.
[Bootstrap](http://getbootstrap.com/) is used as the CSS framework for the site and [City of Helsinki Bootstrap theme](http://terotic.github.io/bootstrap-hel-fi/) is used as the main theme.
Testing framework
-----------------
- [Karma](http://karma-runner.github.io/0.13/index.html) is used to run the tests. On local machines tests are run on [PhantomJS](http://phantomjs.org/) to make running tests in watch mode as smooth as possible. On CI the tests are run on Chrome.
- [Mocha](https://mochajs.org/) is used as the test framework.
- [Chai](http://chaijs.com/) is used for test assertions.
- [simple-mock](https://github.com/jupiter/simple-mock) and [MockDate](https://github.com/boblauer/MockDate) are used for mocking and spies.
- [skin-deep](https://github.com/glenjamin/skin-deep) is used to make testing React components with shallow rendering easier.
License
-------
[The MIT License](http://opensource.org/licenses/MIT)
Copyright (c) 2015 City of Helsinki <[http://www.hel.fi/](http://www.hel.fi/)>