/honghong.me

⚡ My personal website and blog built with TypeScript, Next.js, and Tailwind CSS

Primary LanguageTypeScriptMIT LicenseMIT

小康 blog

View Online · Report Bug · Request New Feature

🌍 honghong.me

👋 Running Locally

  1. Clone the repository
git clone https://github.com/tszhong0411/honghong.me.git
  1. Go to the project directory
cd honghong.me
  1. Install dependencies
yarn
  1. Create a .env.local file and input environment variables based on the .env.example file so that the project can run properly.
# Comment System (Giscus)
# https://giscus.app/
NEXT_PUBLIC_GISCUS_REPO=
NEXT_PUBLIC_GISCUS_REPOSITORY_ID=
NEXT_PUBLIC_GISCUS_CATEGORY=
NEXT_PUBLIC_GISCUS_CATEGORY_ID=

# Spotify Now Playing
# https://developer.spotify.com/documentation/web-api/reference/get-the-users-currently-playing-track
SPOTIFY_CLIENT_ID=
SPOTIFY_CLIENT_SECRET=
SPOTIFY_REFRESH_TOKEN=

# Google API (YouTube stats)
# https://developers.google.com/youtube/v3/getting-started
GOOGLE_PRIVATE_KEY=
GOOGLE_CLIENT_EMAIL=

# Authentication
# https://next-auth.js.org/getting-started/example
NEXTAUTH_SECRET=
NEXTAUTH_URL=http://localhost:3000

# Github OAuth
# https://github.com/settings/applications/new
OAUTH_CLIENT_KEY=
OAUTH_CLIENT_SECRET=

# Github API (Github stats)
# https://github.com/settings/tokens/new
GITHUB_TOKEN=

# Database URL
DATABASE_URL=<DATABASE>://<HOST>:<PORT>/<DB>

# Just some random string (used for hashing)
# You can use https://www.useapassphrase.com/ to generate the string
IP_ADDRESS_SALT=

# WakaTime API Key (Coding hours)
# https://wakatime.com/api-key/
WAKATIME_API_KEY=
  1. Run the development server
yarn dev

🍰 Contributing

Contributions make the open source community an excellent place to learn, inspire and create. Thank you very much for any contributions you make.

If you have better suggestions, fork and create a pull request. You can also simply open an issue with the "enhancement" tag. Don't forget to give this project a star! Thanks again!

  1. Fork the repository
  2. Commit your changes (git commit -m 'Add some Feature')
  3. Push to the branch (git push)
  4. Open a Pull Request

❤️ Credits


Made with ❤️ in Hong Kong