https://github.com/kabeech/star-crossed

A tool for finding a special spot in the universe
https://github.com/kabeech/star-crossed

deno denokv

Last synced: 7 months ago
JSON representation

A tool for finding a special spot in the universe

• Host: GitHub
• URL: https://github.com/kabeech/star-crossed
• Owner: kaBeech
• License: mit
• Created: 2023-06-13T03:29:45.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-01T02:34:32.000Z (about 1 year ago)
• Last Synced: 2025-01-17T09:33:53.073Z (9 months ago)
• Topics: deno, denokv
• Language: TypeScript
• Homepage: https://kabeech.com/fun/star-crossed
• Size: 1.93 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# StarCrossed

A tool for finding a special spot in the universe

Created for the Deno [KV Hackaton](https://deno.com/blog/deno-kv-hackathon)

## About

StarCrossed is inspired by [this xkcd comic:](https://xkcd.com/201/)

![xkcd Christmas GPS comic](/public/xkcd_christmas_gps.png "Christmas GPS")

...but in space!

The basic idea is to input the birthdays of you and a loved one, and return a set of celestial coordinates special to the two of you

In addition to these coordinates, you'll also receive the name of the star closest to these coordinates (within 25 parsecs of Earth), a link to some more information about this star, and a link to an interactive map of the area your coordinates reside in

If the location is out of your starship's range, is too crowded when you get there, or isn't visible from your porch, fear not! Try entering in your birthdays in the reverse order - you'll get a different response this way

Have fun!

## Screenshots

Frontend Demo Screenshot 1:

![Frontend Demo Screenshot 1](/public/demoFrontendScreenshot1.png "Frontend Demo Screenshot 1")

Frontend Demo Screenshot 2: 

![Frontend Demo Screenshot 2](/public/demoFrontendScreenshot2.png "Frontend Demo Screenshot 1")

Demo Info Link (external website) Screenshot:

![Demo Info Link (external website) Screenshot](/public/demoInfoLink.png "Demo Info Link (external website) Screenshot]")

## Technical notes

The main route is a get request on `/star-crossings/:birthdays`, which returns StarCrossingData as JSON

The birthdays are expected to be in the following format: `yyyy-mm-dd,yyyy-mm-dd`

For example, a get request to [hungry-heron-21.deno.dev/star-crossings/1960-1-1,1960-4-17](https://hungry-heron-21.deno.dev/star-crossings/1960-1-1,1960-4-17) will return StarCrossingData

The only other route currently implemented is `/star-catalog`, which lists all the stars loaded into KV

A frontend demo is available at [kabeech.com/fun/star-crossed/](https://www.kabeech.com/fun/star-crossed/)

To start the server: `deno tasks dev` in the root directory

## Acknowledgements

Very special thanks go out to the [Internet Stellar Database](http://www.stellar-database.com/) and the [Universe Guide](https://www.universeguide.com/) for the info links, [skyMap.org](http://www.wikisky.org/?locale=EN) for the skyMaps, and the [Strasbourg Astronomical Data Center](https://cdsarc.cds.unistra.fr/ftp/cats/J/PASP/122/885/) for the starData