redbadger / esma-website

MIT License
0 stars 0 forks source link

esma-website

The repository that hosts the ESMA website and project board.

The website is available to view at https://esma.network/.

Proof-of-Concept

Prior to Discovery, a PoC has been created in this repo using a static site generator - Gatsby. It also uses emotion for styling.

Through our "deploy master" Github Action, the master branch is being built and deployed to Github pages. The CNAME record at ./static/CNAME is pushed to the Github pages built site.

Prerequisites

To build this site locally, you'll need to have ffmpeg. The site features videos which the gatsby-video plugin converts to web-friendly formats at build-time. The plugin relies on ffmpeg being installed.

You'll also need Git Large File Storage (git-lfs) installed.

Mac OS X

On Mac, run the following to install ffmpeg and git-lfs:

brew install ffmpeg git-lfs

Other platforms

Find instructions for your platform at the official websites:

Update this README with successful steps if you can.

Tests

Unit tests

To run jest unit tests, run

npm run test

End-to-end tests

To run cypress browser tests, start your local dev server with

npm run start

then run

npx cypress run

If you want to run against a local optimised build, run npm run build then npm run test-e2e. This mirrors what our Continuous Integration does.

Contributing

Please see Contribution guidelines