Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/city-of-helsinki/outdoors-sports-map
Helsingin kaupungin Ulkoliikuntakartta.
https://github.com/city-of-helsinki/outdoors-sports-map
Last synced: about 1 month ago
JSON representation
Helsingin kaupungin Ulkoliikuntakartta.
- Host: GitHub
- URL: https://github.com/city-of-helsinki/outdoors-sports-map
- Owner: City-of-Helsinki
- License: mit
- Created: 2018-11-07T08:51:15.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-11T11:58:23.000Z (about 1 month ago)
- Last Synced: 2024-11-11T12:39:54.197Z (about 1 month ago)
- Language: TypeScript
- Homepage: https://ulkoliikunta.fi
- Size: 5.86 MB
- Stars: 3
- Watchers: 19
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Outdoor Exercise Map
The Outdoor Exercise Map is an open communications channel for checking the condition of outdoor sports facilities in Helsinki, Espoo, Vantaa and Kirkkonummi. The Outdoor Exercise Map helps the inhabitants of the municipality find up-to-date information on the City’s outdoor sports services. Currently, the services encompasses the skiing tracks, ice-skating fields, swimming places and other public outdoor services maintained by the cities.
## Development
Follow the instructions to set up local development environment. Alternatively, you can use Docker ([see below](#development-with-docker)).
### Prerequisites
- Preferably use current Node.js LTS
- Install [NPM](https://www.npmjs.com/) and [Yarn](https://yarnpkg.com)
### Setup
After cloning this repository, create a new `.env` file from the provided `.env.example` file:
```
cp .env.example .env
```
### Running the development environment
To start development server, run:
```
yarn start
```
The application is now available at [http://localhost:3000](http://localhost:3000/).
## Development with Docker
Install and configure [Docker](https://www.docker.com/).
Build the project:
```
cp .env.example .env
docker-compose build
```
_(you can add `--no-cache` to the command if you don't want to use cache from previous build)_
Start the application:
```
docker-compose up
```
The application is now available at [http://localhost:3000](http://localhost:3000/).
### Starting dockerized production environment
Make sure port `8080` is free.
Pass build-time variables (replace `` with actual variable name from `.env` file) to docker image and build with:
```
source .env
docker build \
--build-arg =${} \
--build-arg =${} \
-t outdoors-sports-map .
```
_(you can add `--no-cache` to the command if you don't want to use cache from previous build)_
Start docker container with:
```
docker container run -p 8080:8080 -d outdoors-sports-map
```
_(you can add `--name outdoors-sports-map` to the command for easier referencing)_
The application is now available at [http://localhost](http://localhost/).
## Environments
### Test
Test environment is done from master branch. The pipeline is triggered with a commit to master branch. Normally the commit is pull request merge.
Test url: [https://ulkoliikunta.test.hel.ninja](https://ulkoliikunta.test.hel.ninja/).
### Review
Review environment is done from pr to master branch. The review environment url is posted to pull request when it is completed.
### Release (staging&production)
Release pipeline is triggered by tag. Tag should be named like 'release-'. The release pipeline builds and deploys the staging environment by default. The production environment requires manual approval in the pipeline [ulkoliikuntakartta-ui-release](https://dev.azure.com/City-of-Helsinki/ulkoliikuntakartta/_build?definitionId=3123&_a=summary)
> Note! Approval requires 2 manual approval, one for build and one for deploy
Staging url: [https://ulkoliikunta.stage.hel.ninja](https://ulkoliikunta.stage.hel.ninja)
Production url: [https://ulkoliikunta.fi](https://ulkoliikunta.fi)