Skip to content

README.md

Latest commit

 

History

History
77 lines (48 loc) · 2.34 KB

README.md

File metadata and controls

77 lines (48 loc) · 2.34 KB

Blankie Website

This is the website for Blankie, built with Astro and deployed on GitHub Pages.

Production

The live site is available at https://blankie.rest

Tech Stack

Performance

The website maintains a perfect 100 score across all categories in Google Lighthouse (Performance, Accessibility, Best Practices, and SEO). All contributions should ensure these scores are maintained.

Development

You can develop either locally or using Docker Compose. Both methods will give you hot-reloading and the same development experience.

Using Docker Compose (Recommended)

# From the `docs` directory, simply run:
docker-compose up

# Or, from the root directory:
cd docs && docker-compose up

The development server will be available at http://localhost:4321. The container will automatically:

  • Mount the parent directory to access required files (FAQ.md, CONTRIBUTING.md, etc.)
  • Copy necessary files from the parent directory
  • Enable hot-reloading for changes in src/ and public/ directories
  • Maintain container-based node_modules to avoid platform issues

Local Development

  • Note: Node.js 22 or later is required to run the development server.

If you prefer developing without Docker, open a terminal inside the docs directory, then run the following commands:

  1. Install dependencies:

    npm install

  2. Start the development server:

    npm run dev

  3. Build for production:

    npm run build

  4. Preview the production build:

    npm run preview

Deployment

The site is automatically deployed to GitHub Pages at https://blankie.rest when changes are pushed to the main branch that affect files in the docs directory or the GitHub Actions workflow file. The deployment is handled by the GitHub Actions workflow defined in .github/workflows/pages.yml.

License

The documentation website is included under the project's MIT License. See the LICENSE file for details.