The OG Star Tracker app is designed to assist astrophotographers in setting up their equipment and capturing the night sky with precision and ease. It provides a checklist to ensure all necessary steps are taken for a successful astrophotography session, along with features to control and monitor the photography process.
- Checklist: A comprehensive list of steps to prepare your equipment and camera settings.
- WiFi Connection Checker: Automatically checks if the device is connected to the correct WiFi network for remote control capabilities.
- Sidereal Tracking: Enables sidereal tracking to follow the stars' movement across the sky.
- Photo Control Inputs Validation: Validates the necessary inputs for capturing photos, including exposure time and frame count.
- Dithering Support: Offers dithering options to improve image quality by reducing noise.
- Capture Management: Tracks the capture start time, count, elapsed time, and estimated time for the photography session.
- App is completely written in Kotlin
- App is completely reactive (we use coroutines and flow)
- For API communication, this app uses REST API, specifically Retrofit and OkHttp3 SDK libraries for Android
- App uses Clean architecture
- App UI is written in Jetpack Compose
- Jetpack Compose - ui library
- Kotlin Corountines - flows, corountines, ...
- Koin - dependency injection / service provider
- Retrofit - network library
- Moshi - parsing json
- Timber - logging
We welcome contributions from the community! If you're looking to contribute to the OG Star Tracker app, here's how you can do so:
-
Fork the Repository
- Start by forking the repository to your GitHub account. This creates a copy of the repository that you can work on independently.
-
Clone Your Fork
- Clone your forked repository to your local machine to start making changes. Use the following command:
git clone https://github.com/OndraGejdos/OG-star-tracker-
- Replace
yourusernamewith your GitHub username.
- Clone your forked repository to your local machine to start making changes. Use the following command:
-
Create a New Branch
- Navigate into the cloned repository and create a new branch for your contributions. It's best practice to name your branch related to the changes you're making. For example:
git checkout -b feature-add-new-checklist-item
- Navigate into the cloned repository and create a new branch for your contributions. It's best practice to name your branch related to the changes you're making. For example:
-
Make Your Changes
- With your new branch checked out, make the changes you'd like to contribute. This could be anything from fixing a bug, adding a new feature, or improving documentation.
-
Commit Your Changes
- After making your changes, commit them to your branch. Be sure to write a clear and concise commit message that explains what you've done:
git commit -am "Add new checklist item for astrophotography setup"
- After making your changes, commit them to your branch. Be sure to write a clear and concise commit message that explains what you've done:
-
Push Your Changes
- Push your changes to your fork on GitHub:
git push origin feature-add-new-checklist-item
- Push your changes to your fork on GitHub:
-
Create a Pull Request
- Go to the original OG Star Tracker repository on GitHub, and you'll see a prompt to create a pull request from your newly pushed branch. Click on "Compare & pull request" and describe the changes you've made, why you've made them, and any other relevant information.
-
Review & Merge
- Once your pull request is submitted, the project maintainers will review your changes. If everything looks good, they will merge your changes into the main project. You might also receive feedback on your pull request; be open to making further adjustments.
By following these steps, you can contribute to the development and improvement of the OG Star Tracker app. We look forward to your contributions!