Work in Progress
Aim: display metrics for github repositories in the swung subsurface slack, based on an opt in policy - any repo that adds the swung-stack
topic will be includes
RThe dashboard is built with the remix framework and deployed on vercel.
To run locally, add a .env
file to the root of the repository and include the line:
GITHUB_TOKEN=ghp_MyGithubAccessToken
That file is ignored, and should not be commited to the repo.
After having run the create-remix
command and selected "Vercel" as a deployment target, you only need to import your Git repository into Vercel, and it will be deployed.
If you'd like to avoid using a Git repository, you can also deploy the directory by running Vercel CLI:
npm i -g vercel
vercel
It is generally recommended to use a Git repository, because future commits will then automatically be deployed by Vercel, through its Git Integration.
To run your Remix app locally, make sure your project's local dependencies are installed:
npm install
Afterwards, start the Remix development server like so:
npm run dev
Open up http://localhost:3000 and you should be ready to go!
If you're used to using the vercel dev
command provided by Vercel CLI instead, you can also use that, but it's not needed.