Skip to content
This repository has been archived by the owner on May 31, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Alezco authored Jan 12, 2021
1 parent 2978499 commit 1e3917c
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,33 @@
# Archifiltre statistics

## Run the app
Archifiltre statistics provides statistics about several Archifiltre metrics. The data comes from our app and website (via Matomo), GitHub and YouTube. We rely on Node.js, Express and TypeScript.

Use the following command:
## Launch the app

First, create a `.env` file based on `.env.example`. You will need API keys for YouTube, GitHub and Matomo.

Then, to install the project's dependencies, run the following command:
```
yarn
```

Finally, use the following command to run the app:
```
yarn start
```

By default, the server will run on `localhost:3000`

## Run tests

To run the tests, use the following command:
```
yarn test
```

## Run linter

To run the linter, use the following command:
```
yarn lint
```

0 comments on commit 1e3917c

Please sign in to comment.