This repository has been archived by the owner on May 31, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
26 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |