https://github.com/city-of-helsinki/linked-volunteering-ui

https://github.com/city-of-helsinki/linked-volunteering-ui

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/city-of-helsinki/linked-volunteering-ui
• Owner: City-of-Helsinki
• Created: 2018-11-25T18:12:15.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-09-13T10:48:49.000Z (3 months ago)
• Last Synced: 2024-09-14T00:29:52.544Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 9.04 MB
• Stars: 1
• Watchers: 25
• Forks: 2
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Linked Volunteering UI

[![Build Status](https://travis-ci.org/City-of-Helsinki/linked-volunteering-ui.svg?branch=develop)](https://travis-ci.org/City-of-Helsinki/linked-volunteering-ui)

## Prerequisites

- Yarn

- Strong recommendation for an IDE: VSCode

### Recommended VSCode plugins:

- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)

- [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)

### Setup

After cloning this repository, create a new `.env.local` file from the provided `.env.example` file and configure it as needed:

```

$ cp .env.example .env.development.local

```

## Development

To start development environment, run:

```

$ yarn start

```

This will start [the application](http://localhost:3000) to run in port `3000`

## Testing

End-to-end testing is created with Cypress.io framework. To run tests:

```

$ yarn cypress

```

## Docker

Before building image docker image at the first time, create a new `.env.local` file from the provided `.env.example` file and configure it as needed:

```

$ cp .env.example .env.production.local

```

`docker-compose build` to build docker image

`docker-compose up` to start the dockerized dev-environment. Not for production!!!  

`docker-compose down` stops the container.