Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/city-of-helsinki/asomap
Asomap is the frontend of the City of Helsinki map service for right-of-occupancy apartments
https://github.com/city-of-helsinki/asomap
Last synced: about 1 month ago
JSON representation
Asomap is the frontend of the City of Helsinki map service for right-of-occupancy apartments
- Host: GitHub
- URL: https://github.com/city-of-helsinki/asomap
- Owner: City-of-Helsinki
- License: mit
- Created: 2016-10-12T13:29:06.000Z (about 8 years ago)
- Default Branch: develop
- Last Pushed: 2022-05-16T17:29:57.000Z (over 2 years ago)
- Last Synced: 2024-04-15T03:18:13.804Z (8 months ago)
- Language: JavaScript
- Size: 140 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
asomap
======
[](https://travis-ci.org/City-of-Helsinki/asomap)
[](https://codecov.io/gh/City-of-Helsinki/asomap/branch/develop)
Requirements
------------
- [node](http://nodejs.org/) `6.5.0`
- [npm](https://www.npmjs.com/) `3.10.3`
Architecture
------------
- [Redux](https://github.com/reactjs/redux) handles the state management of the app. For more info check their awesome [docs](http://redux.js.org/).
- [React](https://facebook.github.io/react/) handles the rendering of the 'views'.
- [react-redux](https://github.com/reactjs/react-redux) is used to connect the Redux Store to React components.
- [reselect](https://github.com/reactjs/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.
- [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. Start the development server:
```
$ npm start
```
### Building production bundle
Follow the instructions below to build the production bundle.
1. Install npm dependencies:
```
$ npm install
```
2. Build the production bundle:
```
$ npm run build
```
### 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](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.
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) is used for mocks and spies.
- [Enzyme](https://github.com/airbnb/enzyme) is used to make testing React Components easier.
License
-------
[The MIT License](http://opensource.org/licenses/MIT)
Copyright (c) 2016 City of Helsinki <[http://www.hel.fi/](http://www.hel.fi/)>