Skip to content

README.md

Latest commit

 

History

History
49 lines (34 loc) · 1.54 KB

README.md

File metadata and controls

49 lines (34 loc) · 1.54 KB

AtlasOS Website

AtlasOS is an optimized modification of Microsoft Windows tailored for gaming and performance. This repo contains the source code for the official website (https://atlasos.net), built with Astro, Tailwind CSS, and Bun.

Table of Contents

Prerequisites

  • Bun ≥ 1.3.0
  • Node.js ≥ 22.0.0

Installation

bun install

Available Scripts

Command Description
bun dev Start local Astro development server
bun run build Build production site & run Jampack
bun preview Preview production build locally
bun format Format files with Prettier
bun run lint Lint code with ESLint
bun run check Runs the Astro check command

Configuration

  • Astro config: astro.config.mjs (integrations, site)
  • Tailwind config: globals.css (minimal config, theme)
  • ESLint config: .eslintrc.cjs (Astro + TypeScript rules)
  • EditorConfig: .editorconfig (consistent editor settings)
  • Gitignore: ignores Jampack cache in .jampack/, build output, lockfiles, etc.

License

This project is licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International (CC BY-NC-ND 4.0). See the LICENSE file for details.