Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shenlu89/shenlu.me
My portfolio built with Next.js, Tailwind, Giscus, Umami, Upstash, MDX, Bun, and Vercel.
https://github.com/shenlu89/shenlu.me
blog bun giscus mdx nextjs redis serverless tailwindcss typescript umami upstash vercel
Last synced: about 1 month ago
JSON representation
My portfolio built with Next.js, Tailwind, Giscus, Umami, Upstash, MDX, Bun, and Vercel.
- Host: GitHub
- URL: https://github.com/shenlu89/shenlu.me
- Owner: shenlu89
- License: mit
- Created: 2020-04-30T17:30:05.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-21T16:12:06.000Z (about 2 months ago)
- Last Synced: 2024-09-27T12:23:17.010Z (about 2 months ago)
- Topics: blog, bun, giscus, mdx, nextjs, redis, serverless, tailwindcss, typescript, umami, upstash, vercel
- Language: MDX
- Homepage: https://shenlu.me
- Size: 14.6 MB
- Stars: 21
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# shenlu.me
Shen Lu's Blog, inspired by [leerob.io](https://leerob.io/).
## Features
- **Framework**: [Next.js](https://nextjs.org)
- **Styling**: [Tailwind CSS](https://tailwindcss.com)
- **Content**: [MDX](https://mdxjs.com/) + [next-mdx-remote](https://github.com/hashicorp/next-mdx-remote)
- **Analytics**: [Umami](https://umami.is/)
- **Comment**: [Giscus](https://giscus.app)
- **Database**: [Redis](https://redis.io/) + [Upstash](https://upstash.com/)
- **Deployment**: [Vercel](https://vercel.com)
- **Manager**: [Bun](https://bun.sh/)
## Overview
- `components/*` - The components defined as functions provide more features for all pages.
- `data/*` - All private information (matadata, headers, articles, etc.) about the pages.
- `lib/*` - A collection of helpful utilities or functions for external services.
- `app/api/*` - [API Routes](https://nextjs.org/docs/app/building-your-application/routing/router-handlers) and Serverless KV with Redis API powered by [Upstash](https://upstash.com/) for post views.
- `app/blog/*` - Static pre-rendered posts using `next-mdx-remote`.
- `content/*` - All the MDX files for blog posts.
- `public/*` - Static public assets including fonts and images.
## Install and Run Locally
This application requires:
- Bun v1.0+ (compatibility with Node.js v20).
- Create a `.env` file similar to [`.env.example`](/.env.example).
```js
git clone [email protected]:shenlu89/shenlu.me.git
cd shenlu.me
// create .env file similar to .env.example
// development mode
bun install
bun dev
// production mode
// bun run build
```
## Deploy on Vercel
[](https://vercel.com/new/clone?repository-url=https://github.com/shenlu89/shenlu.me)
## License
This repository is licensed under [MIT](https://github.com/shenlu89/shenlu89.github.io/blob/main/LICENSE), and the content of all pages is licensed under [CC BY-NC-SA 4.0](http://creativecommons.org/licenses/by-nc-sa/4.0/).