Skip to content

ConorEB/star

Repository files navigation

STAR - Satellite Tracking and Alignment Resource

STAR

STAR is a web interface that helps users align their device (and antenna) with a specified satellite using the device's motion sensors and real-time Two-Line Element (TLE) data. Designed for both beginners and advanced users, STAR simplifies satellite alignment for handheld antennas, particularly useful for HAM radio operators and satellite enthusiasts.

Deploy with Vercel

Tech Stack

  • Next.js 15.1.0
  • React 18
  • TypeScript
  • Tailwind CSS
  • N2YO API for satellite data retrieval

Getting Started

1. Prerequisites

Before you begin, ensure you have the following:

  • Node.js (v18+)
  • Yarn or npm
  • N2YO API Key (to fetch satellite TLE data)

2. Setup the Project

  1. Clone the repository:

    git clone https://github.com/ConorEB/star
    cd star
  2. Install dependencies:

    yarn install

3. Environment Variables

Include your N2YO API key in the .env file in the project's root directory:

N2YO_API_KEY={INSERT_API_KEY}

You can obtain an API key from N2YO (https://www.n2yo.com/login/register). Make sure to replace INSERT_API_KEY with your actual key.

4. Local Development

Start the development server:

yarn dev

Once running, open http://localhost:3000 in your browser to view the application.

This app only works on devices that supply motion data via the web API, which are typically only mobile devices. I reccomend using ngrok to establish a tunnel to a local device if you are running this on a computer.

Demo


Authors


License

This project is released under the MIT License. Refer to the LICENSE file for more information.

About

STAR (Satellite Tracking and Alignment Resource)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published