Skip to content

deeheber/Danielle-s-Blog

Repository files navigation

Danielle's Blog

A modern, fast blog built with Astro and React. PRs welcome - especially if you spot my typos!

🎬 Demo

Check out the live site: https://danielleheberling.xyz/

📦 Prerequisites

Node.js - See .nvmrc file for required version

🚀 Getting Started

npm install
npm run dev

Your blog will be running at localhost:4321

⚙️ Customization

Site Configuration

Update the src/config.ts file to customize:

  • Site metadata (title, description, author)
  • Social media links
  • Logo settings
  • Locale settings

Blog Posts

  • All blog posts are stored in src/content/blog directory
  • Add new posts as markdown files in the src/content/blog directory

Talks

Update the speakingData.json file in src/data directory

🎖️ Available Commands

All commands are run from the root of the project, from a terminal:

Note! For Docker commands we must have it installed in your machine.

Command Action
npm install Installs dependencies
npm run dev Starts local dev server at localhost:4321
npm run build Build your production site to ./dist/
npm run preview Preview your build locally, before deploying
npm run format:check Check code format with Prettier
npm run format Format codes with Prettier
npm run sync Generates TypeScript types for all Astro modules. Learn more.
npm run lint Lint with ESLint
npm run lint:check Check code linting with ESLint
npm run type-check Run TypeScript type checking without emitting files
docker compose up -d Run on docker, You can access with the same hostname and port informed on dev command.
docker compose run app npm install You can run any command above into the docker container.

💻 My Tech Stack

Main Framework - Astro
Type Checking - TypeScript
Component Framework - ReactJS
Styling - TailwindCSS
Fuzzy Search - FuseJS
Code Formatting - Prettier
Linting - ESLint
Deployment - Cloudflare Pages