Article Page

⚠️ This app does not yet do anything.

It's written in TypeScript, and uses the Koa framework.

Table of contents

1. Development
   1. Running the app
   2. Running the tests
      1. Mutation tests
   3. Linting
2. Contributing
3. Getting help
4. License

Development

Requirements

• Docker
• GNU Bash
• GNU Make
• Node.js

The project contains a Makefile which uses Docker Compose for development and testing.

You can find the possible commands by executing:

make help

Running the app

To build and run the app for development, execute:

make dev

You can now access the app at http://localhost:8080.

Rebuilding the container

Code is attached to the containers as volumes so most updates are visible without a need to rebuild the container. However, changes to NPM dependencies, for example, require a rebuild. So you may need to execute

make build

before running further commands.

Running the tests

We use Jest to test the app. You can run it by executing:

make test

Mutation tests

We use Stryker for mutation testing, which makes sure that the Jest tests are effective. You can run it by executing:

make test:mutation

Linting

We lint the app with ESLint. You can run it by:

make lint

You can fix problems, where possible, by executing:

make lint:fix

Contributing

Pull requests and other contributions are more than welcome. Please take a look at the contributing guidelines for further details.

Getting help

• Report a bug or request a feature on GitHub.
• Ask a question on the Libero Community Slack.
• Read the code of conduct.

License

We released this software under the MIT license. Copyright © 2020 eLife Sciences Publications, Ltd.