Skip to content

Contributing to OrbitView

SpaceEngineerSS edited this page Dec 20, 2025 · 1 revision

Contributing to OrbitView ๐Ÿ’ป

First of all, thank you for considering contributing to OrbitView! We are an open-source project dedicated to making space data accessible to everyone.

๐Ÿ› ๏ธ Setup Local Development

  1. Clone the Repo:
    git clone https://github.com/SpaceEngineerSS/OrbitVieW.git
    cd OrbitVieW
  2. Install Dependencies:
    npm install
  3. Environment Setup: Copy .env.production.example to .env.local and add your settings.
  4. Run Dev Server:
    npm run dev

๐Ÿงช Testing Policy

We use Jest for unit testing. All new features (especially mathematical calculations) must include tests.

npm test          # Run all tests
npm run lint      # Check code style

๐Ÿ“œ Pull Request Guidelines

  • Branches: Create a feature branch from main (e.g., feature/add-moon-phase).
  • Commits: Use Conventional Commits (e.g., feat:, fix:, docs:).
  • Approval: All PRs require a passing CI pipeline and at least one review.

๐Ÿš€ Deployment

If you wish to deploy your own instance, follow the Deployment Guide.


Questions? Open an Issue or contact the developer at spacegumus.com.tr.

Clone this wiki locally