https://github.com/athackst/dashboard
https://github.com/athackst/dashboard
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/athackst/dashboard
- Owner: athackst
- Created: 2023-07-10T05:51:52.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2026-01-15T19:29:05.000Z (5 months ago)
- Last Synced: 2026-01-15T21:50:30.347Z (5 months ago)
- Language: JavaScript
- Homepage: https://dashboard.althack.dev
- Size: 839 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Github Dashboard
Live: [dashboard.althack.dev](https://dashboard.althack.dev)
If you want your own copy to play around with, the quickest way to get it up and running is clicking the Deploy to Netlify button below. It will clone this repository into your own account, and deploy the site to Netlify
[](https://app.netlify.com/start/deploy?repository=https://github.com/athackst/dashboard)
You will want to update add or update your `_config.yml` file with information about your repository
```yaml
theme: jekyll-theme-profile
repository: athackst/dashboard # The name of your repository
url: https://dashboard.althack.dev # The url of your host
```
You will need to set [environment variables](https://docs.netlify.com/configure-builds/environment-variables/) with your [Github Personal Access Token](https://github.com/settings/tokens) and username.
- `GITHUB_USERNAME`: Your github user name
- `GITHUB_TOKEN`: Your github token
These allow the dashboard to pull your repository information (read-only public access required).
## Setup
To run the dashboard locally, you can use the [Visual Studo Code](https://code.visualstudio.com/) with the [Dev Container](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) plugin which includes everything you need to get started including the following:
**System Requirements**
- git
- NodeJS
- Ruby
`cd` into your local copy of the repository and open it with code
```bash
cd dashboard
code .
```
Then `Ctrl+Shift+P` to open the command pallet and search for `Dev Containers: Reopen in Container`.
## Running locally
Create a `.env` file to store secrets locally.
Next, run `netlify dev` to start the remote development server.
This will start the client server on [http://localhost:8888](http://localhost:8888)