codebar / stats

A webpage that shows up-to-date statistics for codebar

codebar stats

Website for viewing up-to-date statistics for codebar.

Setup up

Make sure node is installed - I recommend using nvm.

This project uses yarn workspaces, so you'll need to install the dependency manager yarn.

Install packages needed for this project:

yarn

Fetching the data

This repo contains a script for running SQL queries against the codebar Postgres database.

The script writes the result of the queries to the data directory within the front end.

To fetch the data, run

yarn data

Note that to run this script locally you'll need a .env file in the root of the repo, which needs to looks like this:

DB_URL=<databse-url>

The databse url can be found in Heroku.

Start the frontend

yarn start

See more here

How to deploy?

Simply pushing to master will trigger Github Actions to run checks and then deploy to Github Pages.

Read more here.