Skip to content

akari-blue/akari

Repository files navigation

Akari

image Source: https://bsky.app/profile/fettstorch.com/post/3leti7crg2k2b

Contribution Guidelines

We welcome contributions! Before submitting a pull request, please open an issue to discuss your proposed changes. This helps us track changes even if PRs are closed or abandoned.

  • Translations: When adding a new language, please specify the region (e.g., French vs. Canadian French). If starting with a general version, that's fine—just ensure to rename appropriately if regional variants are added later.
  • PR Previews: We offer PR previews deployed to Cloudflare, allowing contributors to push updates and review changes.

Development Environment Setup

To set up Akari for development:

  1. Fork the Repository: Start by forking the repository to your own GitHub account.
  2. Clone Your Fork: git clone https://github.com/your-username/akari
  3. Install Dependencies: Run npm ci to install dependencies without updating package versions.
  4. Run the Development Server: Use npm run dev to start the development server.

License

Akari is licensed under the CC0-1.0 license, meaning contributions are essentially public domain.