Linked Volunteering UI

Prerequisites

• Yarn
• Strong recommendation for an IDE: VSCode

Recommended VSCode plugins:

• ESLint
• Prettier - Code formatter

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 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.