Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danielroe/firstcommit.is
Find your first open-source commit on GitHub
https://github.com/danielroe/firstcommit.is
api commit github nuxt oauth
Last synced: 14 days ago
JSON representation
Find your first open-source commit on GitHub
- Host: GitHub
- URL: https://github.com/danielroe/firstcommit.is
- Owner: danielroe
- License: mit
- Created: 2023-08-23T15:16:55.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-22T13:00:37.000Z (6 months ago)
- Last Synced: 2024-05-22T13:39:46.643Z (6 months ago)
- Topics: api, commit, github, nuxt, oauth
- Language: Vue
- Homepage: https://firstcommit.is
- Size: 381 KB
- Stars: 114
- Watchers: 3
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# firstcommit.is
> Find your first open-source commit on GitHub
- [👉 Check it out](https://firstcommit.is/)
## Features
- Built on [Nuxt](https://nuxt.com/)
- [Nitro server API routes](https://nuxt.com/docs/guide/concepts/server-engine#server-engine)
- [GitHub API](https://docs.github.com/en/rest) and [OAuth](https://docs.github.com/en/apps/oauth-apps)
- [Cal Sans](https://github.com/calcom/font) font
- [Tailwind CSS](https://tailwindcss.com/)
- [nuxt-og-image](https://github.com/harlan-zw/nuxt-og-image), powered by [Satori](https://github.com/vercel/satori)
- Deployed on [Vercel](http://vercel.com), using ISR with [route rules](https://nitro.unjs.io/guide/cache#route-rules) to persist images, HTML and API requests permanently to a global CDN.
## Try it out locally
1. Generate a new GitHub token [here](https://github.com/settings/tokens).
2. Create an OAuth application and obtain a client secret and client ID [here](https://github.com/settings/developers).
Set your environment variables in a `.env` file:
```env
NUXT_GITHUB_TOKEN=
NUXT_GITHUB_CLIENT_SECRET=
NUXT_GITHUB_CLIENT_ID=
```
### Setup
```bash
# install dependencies
corepack enable
pnpm install
# serve in dev mode, with hot reload at localhost:3000
pnpm dev
# build for production
pnpm build
# preview in production mode
pnpm preview
```
## Credits
Thanks to [**@beerose**](https://github.com/beerose) for the domain name suggestion!
## License
Made with ❤️
Published under [MIT License](./LICENCE).