Skip to content

README.md

Latest commit

 

History

History
101 lines (64 loc) · 2.5 KB

README.md

File metadata and controls

101 lines (64 loc) · 2.5 KB

CTX OS Repository

This is the official repository for the CTX OS configuration layer.

Quick Install

To apply the CTX OS layer to any Debian Bookworm system, run:

curl -sL https://ctxos.github.io/install.sh | bash

🦜 CtxOS Official Website

This is the official CtxOS website, built with Next.js, React, and TypeScript. It serves as the central hub for users to download the CtxOS operating system, stay updated via the blog, and access the RSS feed for blog content. The site is fast, responsive, and designed with accessibility and performance in mind.

🚀 Features

  • ⚛️ Modern stack with Next.js, React 19, and TypeScript
  • 🎨 Styled with Material-UI and Emotion
  • 📰 Integrated Markdown blog with RSS feed
  • 🔍 Accessible and SEO-optimized

📦 Tech Stack

  • Frontend: React 19, Next.js 15
  • Styling: MUI (v5), Emotion, JSS

🛠️ Getting Started

Prerequisites

  • Node.js >= 16.x
  • Yarn or npm

Installation

Use the package manager of your choice, we use yarn.

git clone https://github.com/ctxos/ctxos.github.io.git

cd website

yarn install

yarn run dev

A default browser window will automatically start at localhost:3000

🤝 Contributing

The CtxOS website is an ongoing work in progress, and we welcome help from the community to make it better! Whether you want to fix a bug, add a feature, improve accessibility, or help with documentation — your contribution matters.

How to Contribute

  1. Fork the repository to your Gitlab account.

  2. Clone your fork locally:

    git clone https://github.com/ctxos/ctxos.github.io.git
cd website

  3. Create a new branch for your change:

    git checkout -b feature/your-feature-name

  4. Make your changes — whether that's code, styles, content, or documentation.

  5. Commit your changes with a meaningful message:

    git commit -m "feat: short description of your change"

  6. Push to your forked repo:

    git push origin feature/your-feature-name

  7. Open a Pull Request on the dev branch. Please provide a clear description of what your change does and why it's needed.

👥 Maintainers

Currently, the website is being maintained by the CtxOS team.
For any questions, suggestions, or issues, feel free to reach out to: