Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/catnose99/timeline
catnose's timeline
https://github.com/catnose99/timeline
Last synced: 9 days ago
JSON representation
catnose's timeline
- Host: GitHub
- URL: https://github.com/catnose99/timeline
- Owner: catnose99
- Created: 2021-02-23T07:01:07.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-02-17T02:10:04.000Z (over 2 years ago)
- Last Synced: 2024-08-02T22:22:14.210Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 119 KB
- Stars: 65
- Watchers: 0
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# catnose99/timeline
[](https://github.com/catnose99/timeline/actions/workflows/deployment.yml)
Personal website gathering my activities on the internet.
## Usage
The feed are regularly updated by fetching data from specified sources: RSS feed or Google spreadsheet.
### configuration
#### Create Google Spreadsheet
1. Create a sheet.
2. Set sheet header (first row in the sheet) exactly as follows.
```
date | title | action | url | description | excluded | from_rss
```
[Real world sheet example](https://docs.google.com/spreadsheets/d/1xMmgneTK_yTE6q8fg-18uLKubh2HHvuV2BKksnWk69s/edit?usp=sharing)
#### Configure keys
This is required to access a sheet systematically.
1. On [GCP IAM console](https://console.cloud.google.com/iam-admin/iam), create a service account.
2. Generate a key for the service account with JSON format.
3. Open the spreadsheet and paste service account mail(`[email protected]`) on Collaboration settings.
4. Create `.env` with the following contents on project root dir.
```bash
SHEET_ID='foo' # extracted from the sheet url.
GOOGLE_SERVICE_ACCOUNT_EMAIL='bar' # [email protected]
GOOGLE_PRIVATE_KEY='baz' # copy "private_key" in json (downloaded on step.2)
```
#### Configure scheduled deployments
You can configure scheduled deployments via Github Actions easily. (See `/.github/workflows`)
To make actions work, save the following values in [repository secrets](https://docs.github.com/en/actions/reference/encrypted-secrets).
- `VERCEL_TOKEN`
- `PROJECT_ID`
- `ORG_ID`
`VERCEL_TOKEN` can be generated on [Vercel dashboard](https://vercel.com/account/tokens). `PROJECT_ID` and `ORG_ID` can be found in `.vercel/project.json` which is generated after running `vercel` command locally.
### development
```bash
# install packages
$ npm install
# generate .items.json which has the feed sources.
$ npm run build:items
# start local server
$ npm run dev
```
### deployment
I recommend you deploy on static website hosting services such as Vercel, Netlify or Cloudflare Pages. Note that build commands are configured properly.
```bash
# build commands
$ npm run build
```
To keep the feed fresh, you need to rebuild the app periodically.
## Licence
MIT except for logo (`/public/icon.*`). Be sure to replace them when you fork this repo.