Skip to content

tryandromeda/website

Repository files navigation

Andromeda Website

The official website and docs for Andromeda, a modern JavaScript and TypeScript runtime built entirely in Rust and powered by the Nova JavaScript engine.

🌐 Live Website

Visit the live documentation at: tryandromeda.dev

🛠️ Development

Prerequisites

  • Deno 2.0 or higher

Getting Started

  1. Clone the repository:

    git clone https://github.com/tryandromeda/website.git
    cd website
  2. Start the development server:

    deno task dev
  3. Open your browser to http://localhost:8000

📝 Contributing to Documentation

We welcome contributions to improve the documentation! Here's how you can help:

Adding New Documentation

  1. API Documentation: Add new files to static/content/docs/api/
  2. Examples: Add code examples to static/content/docs/examples/
  3. Guides: Add tutorials to static/content/docs/

Writing Style Guide

  • Use clear, concise language
  • Include practical code examples
  • Follow the existing markdown structure
  • Test all code examples with Andromeda

🚀 Building & Deployment

Building for Production

To create a production build:

deno task build

This generates optimized assets in the _fresh/ directory.

Running in Production

After building, start the production server:

deno run -A _fresh/server.js

Or use the start task (for development):

deno task start

Deployment Notes

  • main.ts: Re-exports from main.tsx for Fresh build compatibility
  • Build Output: The _fresh/ directory contains the compiled server and assets
  • Environment: Ensure Deno 2.0+ is installed on your deployment platform
  • Port: Default port is 8000 (configurable via environment variables)

Deploy to Deno Deploy

  1. Push your changes to GitHub
  2. Connect your repository to Deno Deploy
  3. Set the build command: deno task build
  4. Set the entry point: _fresh/server.js

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

📄 License

This project is licensed under the Mozilla Public License Version 2.0.

🆘 Support

🔗 Links


Releases

No releases published

Packages

No packages published

Contributors 5