https://github.com/victor-teles/victormesquita.dev

My personal tech blog
https://github.com/victor-teles/victormesquita.dev

Last synced: 3 days ago
JSON representation

My personal tech blog

• Host: GitHub
• URL: https://github.com/victor-teles/victormesquita.dev
• Owner: victor-teles
• License: mit
• Created: 2024-10-27T02:41:48.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-11-15T01:32:33.000Z (3 months ago)
• Last Synced: 2024-11-15T02:26:29.782Z (3 months ago)
• Language: TypeScript
• Homepage: https://victormesquita-dev.vercel.app
• Size: 10.6 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## My personal site

### Getting started

1. Install the `yarn` package manager

2. Run `yarn` in the project directory

3. Run `yarn dev` to start a local developer server

### Environment variables

- `GITHUB_TOKEN`: necessary if you want to fetch github stars for projects

- `NEXT_PUBLIC_SUPABASE_URL`, `SUPABASE_SERVICE_ROLE_KEY`, `NEXT_PUBLIC_SUPABASE_ANON_KEY`: required for analytics. See https://maxleiter.com/blog/supabase-next-analytics for more info

- If you want the git commit hash in the bottom of the home page, you need to host with vercel or provide a `NEXT_PUBLIC_VERCEL_GIT_COMMIT_SHA` env var

### Usage:

- `yarn `:

    - `lint`: automatically lints files

    - `dev`: start a local instance with live reloading

    - `rss`: generate an RSS feed

    - `build`: generate an RSS feed and production site

    - `analyze`: generate a bundle you can inspect via @next/bundle-analyzer

    - `start`: start a production instance built via `yarn build`

### Directory structure:

- app

 - `components/`: react components

 - `data/`: static data that can eventually be moved to a DB or something

 - `lib/`: hooks, 3rd party API stuff, utils functions

 - `pages/`: next.js pages (the actual routes that are rendered)

 - `styles/`: contains the global styles

- `pages/api`: nextjs API routes

- `posts/`: markdown files rendered at build time

- `public/`: images for blog, favicon, built files

- `scripts/`: contain the scripts for building the sitemap and RSS feed