danielroe.dev
[READ-ONLY] Mirror of https://github.com/danielroe/firstcommit.is. Find your first open-source commit on GitHub
firstcommit.is
api
commit
github
nuxt
oauth
docs: add README + LICENCE
author
Daniel Roe
date
(Sep 1, 2023, 10:45 PM +0100)
commit
eda5a280
eda5a2800534c08e823dc5b076bb517566158364
parent
2029a3c5
2029a3c59ac6f50873acb908de2c1ab2dd4712be
+79
+21
LICENCE
+21
LICENCE
···
1
+
MIT License
2
+
3
+
Copyright (c) 2023 Daniel Roe
4
+
5
+
Permission is hereby granted, free of charge, to any person obtaining a copy
6
+
of this software and associated documentation files (the "Software"), to deal
7
+
in the Software without restriction, including without limitation the rights
8
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+
copies of the Software, and to permit persons to whom the Software is
10
+
furnished to do so, subject to the following conditions:
11
+
12
+
The above copyright notice and this permission notice shall be included in all
13
+
copies or substantial portions of the Software.
14
+
15
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+
SOFTWARE.
+58
README.md
+58
README.md
···
1
+
# firstcommit.is
2
+
3
+
> Find your first open-source commit on GitHub
4
+
5
+
<p align="center">
6
+
<a href="https://firstcommit.is/" target="_blank">
7
+
<img width="1090" alt="Screenshot of firstcommit.is showing @danielroe's first commit" src="https://github.com/danielroe/firstcommit.is/assets/28706372/0117c4e2-aa2f-482d-ac58-a7195e5c4902">
8
+
</a>
9
+
</p>
10
+
11
+
- [👉 Check it out](https://firstcommit.is/)
12
+
13
+
## Features
14
+
15
+
- Built on [Nuxt](https://nuxt.com/)
16
+
- [Nitro server API routes](https://nuxt.com/docs/guide/concepts/server-engine#server-engine)
17
+
- [GitHub API](https://docs.github.com/en/rest) and [OAuth](https://docs.github.com/en/apps/oauth-apps)
18
+
- [Cal Sans](https://github.com/calcom/font) font
19
+
- [Tailwind CSS](https://tailwindcss.com/)
20
+
- [nuxt-og-image](https://github.com/harlan-zw/nuxt-og-image), powered by [Satori](https://github.com/vercel/satori)
21
+
- 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.
22
+
23
+
## Try it out locally
24
+
25
+
You will need to generate a new GitHub token [here](https://github.com/settings/tokens), as well as an OAuth client secret and client ID [here](https://github.com/settings/developers).
26
+
27
+
```env
28
+
NUXT_GITHUB_TOKEN=
29
+
NUXT_GITHUB_CLIENT_SECRET=
30
+
NUXT_GITHUB_CLIENT_ID=
31
+
```
32
+
33
+
### Setup
34
+
35
+
```bash
36
+
# install dependencies
37
+
corepack enable
38
+
pnpm install
39
+
40
+
# serve in dev mode, with hot reload at localhost:3000
41
+
pnpm dev
42
+
43
+
# build for production
44
+
pnpm build
45
+
46
+
# preview in production mode
47
+
pnpm preview
48
+
```
49
+
50
+
## Credits
51
+
52
+
Thanks to [**@beerose**](https://github.com/beerose) for the domain name suggestion!
53
+
54
+
## License
55
+
56
+
Made with ❤️
57
+
58
+
Published under [MIT License](./LICENCE).