Skip to content

Latest commit

 

History

History
218 lines (154 loc) · 6.42 KB

README.md

File metadata and controls

218 lines (154 loc) · 6.42 KB
Raw

lego-webapp DroneCI dependencies Status devdependencies Status

Open source frontend for abakus.no

MIT last commit coontibutors

Issues: We track issues in the main repo of LEGO: https://github.com/webkom/lego

open issues

Getting Started

Installing dependencies

$ yarn

Starting the client

$ yarn start

Everything should be up and running on localhost:3000.

For instructions on how to run the backend, see webkom/lego.

Running without a local backend

It is possible to run the frontend without running the backend, by using our staging environment:

$ yarn start:staging

Server side rendering

In production we use server side rendering. Due to bad hot reloading, we don't use it by default in dev. The server side renderer can be started by running:

$ yarn build
$ yarn ssr # or yarn ssr:staging

Environment Variables

  • NODE_ENV (optional)
    • development during development and production when using in (or testing for) production
  • API_URL (optional)
    • Url to the LEGO api. Usually ends with /api/v1
  • WS_URL (optional)
    • Url to the LEGO websocket endpoint
  • BASE_URL (optional)
    • Url to the base of the LEGO api. Usaully just the root domain.
  • SEGMENT_WRITE_KEY (optional)
  • CAPTCHA_KEY (optional)
  • STRIPE_KEY (optional)
  • RAVEN_DSN (optional)
  • SERVER_RAVEN_DSN(optional)
  • RELEASE(optional)
    • Release version used when sending exceptions to Sentry. Injected when building docker images
  • ENVIRONMENT(optional)
    • When this isn't production there will be a big red development bar on the top of the page
  • HOST(optional)
    • Used for binding port. Use 0.0.0.0 to make the server publicly accessible
  • PORT(optional)
    • Port to bind
  • SSR_API_URL(optional)
    • Same as API_URL, but used by the SSR. If this is empty, it will fallback to API_URL
  • HTTPS(optional)
  • HTTPS_CERT_KEY_FILE(optional)
    • Filename to https cert key file. Defaults to localhost-cert
  • HTTPS_CERT_FILE(optional)
    • Filename to https cert file. Defaults to localhost-cert

Default values can be found in server/env.js and config/env.js.

Documentation

For simple component documentation we use react-docgen, with react-styleguidist for easy style guide generation.

Start dev server (with hot reload), and go to localhost:6060.

$ yarn styleguide

To build a static version of the documentation, run:

$ yarn styleguide:build

Prettier

We use prettier for JS auto-formatting. When the code isn't formatted with the prettier version in package.json, the tests will fail. We highly recommend using format on save via an editor plugin, for example prettier-atom and vim-prettier.

You can also format the code via yarn prettier.

Tests

Unit tests (jest)

Run all the tests and check for lint errors with the command:

$ yarn test

For development you can run the tests continuously by using:

$ yarn test:watch

A coverage report can be generated by running yarn test -- --coverage.

End to end tests (cypress)

In order to run end to end tests, you need to run both lego-webapp and lego. Lego can be found here: https://github.com/webkom/lego. Lego is assumed to have a clean development database, follow the steps below to achieve that.

Backend

$ cd ../lego
$ docker-compose up -d # Start all services that lego depends on
$ python manage.py initialize_development # Initialize and load data sources (postgres)
$ docker-compose restart lego_cypress_helper # The cypress helper resets database between every test and might need this restart to function correctly
$ python manage.py runserver

Frontend

Start up the node server

$ yarn start

And start cypress in another terminal

$ yarn cypress open

Alternative: You can also run the node server with server side rendering enabled. This is how the tests are run on CI. To do this, you build and start the server

$ yarn build
$ yarn ssr

And you run cypress headlessly (no visible browser) in another terminal

yarn cypress run

Flow

Flow is gradually being introduced so we can reap the benefits of static type checking.

Run flow in the project directory to check if everything is good.

Linting

ESLint and Stylelint is used to maintain high code quality and a unified code style. Please run them before committing code.

To run the linter, use:

$ yarn run lint

# or
$ yarn run lint:js
$ yarn run lint:css
$ yarn run lint:prettier

Some ESLint errors can be fixed by running

$ yarn lint:js -- --fix

Some formatting errors reported by prettier can be fixed by running

$ yarn prettier

Debugging

To debug chunk size (size of the javascript sent to the browser), run

$ BUNDLE_ANALYZER=true yarn build