Skip to content
Snippets Groups Projects
README.md 1.51 KiB
Newer Older
# Helpful contact form
## How to start

### Using VSCode

You can use any editor you like, but the following instructions lead to a 
containerised dev environment using VSCode or Codium:

Open VSCode and press `Ctrl+P`, then run:

```
ext install ms-vscode-remote.remote-containers
```

This installs an extension you can use to run dev environments from containers.
It will run the VSCode backend inside the container so autocomplete, linting,
introspection, etc. works with the version of the interpreter and dependencies
used in production, and independent of those installed on your computer.

Next: `Ctrl+P`, start typing: `Reopen in Container` and hit `Return`.

You can now use any of the scripts defined in `package.json`, described below.
### Using any other editor

You can run the development container manually like this: `docker-compose up`.
This will run `npm start` internally, exposed to port `8080` on localhost.

## Available Scripts

### npm start

Runs the app in the development mode.
Open http://localhost:8080 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

### npm run build

Builds a static copy of your site to the `dist/` folder.
Your app is ready to be deployed!

### npm test

Launches the application test runner.
Run with the `--watch` flag (`npm test -- --watch`) to run in interactive watch mode.

## UI specification

The UI to be implemented is recorded at
https://www.figma.com/file/Sg93oSK3NqTpzfs04rSEog/GH-Contact-form?node-id=0%3A1