Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #100

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README.md #100

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1036c8
Update README.md
krkarma777 Mar 23, 2024
c43d234
Update README.md
krkarma777 Mar 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Update README.md
  • Loading branch information
@krkarma777
krkarma777 authored Mar 23, 2024
commit f1036c852230345bef94e9be4369c1e478c0c863
48 changes: 0 additions & 48 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,49 +1 @@
<p align="center">
<a href="https://lovera.maxam.now.sh/">
<img src="https://user-images.githubusercontent.com/25841814/79395484-5081ae80-7fac-11ea-9e27-ac91472e31dd.png" alt="screenshot" width="500">
</a>
<h3 align="center">📌✨productive-box</h3>
</p>

<p align="center">
<img src="https://img.shields.io/badge/language-typescript-blue?style"/>
<img src="https://img.shields.io/github/license/maxam2017/productive-box"/>
<img src="https://img.shields.io/github/stars/maxam2017/productive-box"/>
<img src="https://img.shields.io/github/forks/maxam2017/productive-box"/>
</p>
<p align="center">
Are you an early 🐤 or a night 🦉?
<br/>
When are you most productive during the day?
<br/>
Let's check out in gist!
</p>

---

> This project is inspired by an awesome pinned-gist project.<br/>Find more in https://github.com/matchai/awesome-pinned-gists

## Overview
This project uses GitHub graphQL API to get the commit histories and write into the gist by [rest.js](https://github.com/octokit/rest.js#readme)

## Setup

### Prep work
1. Create a new public GitHub Gist (https://gist.github.com/)
1. Create a token with the `gist` and `repo` scope and copy it. (https://github.com/settings/tokens/new)
> enable `repo` scope seems **DANGEROUS**<br/>
> but this GitHub Action only accesses your commit timestamp in repository you contributed.

### Project setup

1. Fork this repo
1. Open the "Actions" tab of your fork and click the "enable" button
1. Edit the [environment variable](https://github.com/maxam2017/productive-box/blob/master/.github/workflows/schedule.yml#L17-L18) in `.github/workflows/schedule.yml`:

- **GIST_ID:** The ID portion from your gist url: `https://gist.github.com/maxam2017/`**`9842e074b8ee46aef76fd0d493bae0ed`**.
- **TIMEZONE:** The timezone of your location, eg. `Asia/Taipei` for Taiwan, `America/New_York` for America in New York, etc.

1. Go to the repo **Settings > Secrets**
1. Add the following environment variables:
- **GH_TOKEN:** The GitHub token generated above.
1. [Pin the newly created Gist](https://help.github.com/en/github/setting-up-and-managing-your-github-profile/pinning-items-to-your-profile)