mirror of
https://github.com/jakejarvis/jarv.is.git
synced 2025-04-26 21:48:27 -04:00
42 lines
4.4 KiB
Markdown
42 lines
4.4 KiB
Markdown
# 🏡 [jarv.is](https://jarv.is/)
|
|
|
|
[](https://github.com/jakejarvis/jarv.is/actions?query=workflow%3ACI+branch%3Amain)
|
|
[](https://vercel.com/deployments/jarv.is)
|
|
[](https://github.com/gohugoio/hugo)
|
|
[](https://creativecommons.org/licenses/by/4.0/)
|
|
[](https://github.com/jakejarvis/jarv.is)
|
|
[](http://jarvis2i2vp4j4tbxjogsnqdemnte5xhzyi7hziiyzxwge3hzmh57zad.onion/)
|
|
|
|
Personal website of [@jakejarvis](https://github.com/jakejarvis), created and deployed using [Hugo](https://gohugo.io/), [Vercel](https://vercel.com/), [and more](https://jarv.is/humans.txt).
|
|
|
|
I keep an ongoing list of [post ideas](https://github.com/jakejarvis/jarv.is/issues/1) and [coding to-dos](https://github.com/jakejarvis/jarv.is/issues/11) as issues in this repo. Outside contributions, improvements, and/or corrections are welcome too!
|
|
|
|
## 💾 Starting a local development server
|
|
|
|
### 🧶 Using Yarn:
|
|
|
|
Run `yarn install` and `yarn start`, then open [http://localhost:1337/](http://localhost:1337/). ([Yarn must be installed](https://yarnpkg.com/en/docs/install) first; NPM _should_ also work at your own risk.) Hugo, [Webpack](https://webpack.js.org/), and [Gulp](https://gulpjs.com/) will automatically work together to build the site, and pages will live-refresh via [Browsersync](https://browsersync.io/) when source files are changed.
|
|
|
|
### ▲ Using [`vercel dev`](https://vercel.com/docs/cli#commands/dev):
|
|
|
|
The [Vercel CLI](https://vercel.com/docs/cli) is not included as a project dependency here, but [installing it globally](https://vercel.com/cli) (`npm i -g vercel`) and running `vercel dev` in this repository will build and serve the static site automatically via Yarn **as well as the [serverless functions](/api)** used in production. Pretty nifty! (Note: the CLI will usually start the server at [http://localhost:3000/](http://localhost:3000/) instead of port 1337.)
|
|
|
|
### 🤯 Why does this look _way_ more complex than it needs to be?!
|
|
|
|
[Because it is.](https://www.jvt.me/talks/overengineering-your-personal-website/)
|
|
|
|
## 📜 Licenses
|
|
|
|
|
|
|
|
Site content (everything in [`content/notes`](content/notes/)) is published under the [**Creative Commons Attribution 4.0 International License**](LICENSE.md) (CC-BY-4.0), which means that you can copy, redistribute, remix, transform, and build upon the content for any purpose as long as you give appropriate credit.
|
|
|
|
All original code in this repository (like my [Hugo theme](layouts/)) is published under the [**MIT License**](https://opensource.org/licenses/MIT).
|
|
|
|
Third-party dependencies and assets include:
|
|
|
|
- [**Twemoji**](https://twemoji.twitter.com/): Copyright (c) 2020 Twitter, Inc. and other contributors. [Licensed under CC-BY-4.0.](https://github.com/twitter/twemoji/blob/v13.1.0/LICENSE-GRAPHICS)
|
|
- [**Inter**](https://rsms.me/inter/): Copyright (c) 2016-2020 The Inter Project Authors. [Licensed under the SIL Open Font License, Version 1.1.](https://github.com/rsms/inter/blob/v3.15/LICENSE.txt)
|
|
- [**Roboto Mono**](https://fonts.google.com/specimen/Roboto+Mono): Copyright (c) 2015 The Roboto Mono Project Authors. [Licensed under the Apache License, Version 2.0.](https://github.com/google/fonts/blob/4df0b673c9b316ad5e8de8fa70b0768ab66c87d6/apache/robotomono/LICENSE.txt)
|
|
- [**Comic Neue**](http://comicneue.com/): Copyright (c) 2014 The Comic Neue Project Authors. [Licensed under the SIL Open Font License, Version 1.1.](https://github.com/crozynski/comicneue/blob/v2.5/OFL.txt)
|