Skip to content

HeyImMatt/orbital-sky

 
 

Repository files navigation

What's Up, Spock?

GitHub repo code size GitHub contributors GitHub stars GitHub forks

Created by: Matt McFarland, Alan Puglisi, and James Reid

Created for NASA's 2020 International Space App Challenge, What's Up, Spock? is the ultimate tool for tracking your local satellite activity. Simply click the button and your location will be cross-referenced with multiple databases of international satellites near your current location.

Check it out here: https://whats-up-spock.herokuapp.com/

Technologies Used

Frontend

  • JavaScript
  • Bootstrap
  • HTML
  • CSS

Backend

  • Python
  • Flask
  • SQLAlchemy

Database

  • PostgreSQL

Credits

Prerequisites

Before you begin, ensure you have met the following requirements:

  • You have an Internet browser (Chrome, Firefox, Safari, etc)
  • You have a code editor (VS Code, Atom, etc)
  • You have python3 and pip

Installation

To install, follow these steps:

Via Downloading from GitHub:

  1. Download this repository onto your machine by clicking the "Clone or Download" button or Fork the repo into your own Github account
  2. Download and extract the zip file to a directory of your choice.

Via command line:

$ git clone https://github.com/puglisac/orbital-sky.git

Backend Environment Setup:

  1. In the directory you've cloned or downloaded the repo to, create the virtual environment and activate it
$ python3 -m venv venv
$ source venv/bin/activate
  1. Install dependencies
(venv)$ pip3 install -r requirements.txt
  1. Install PostgreSQL if you do not have it.

  2. Create a database and seed it

$ createdb satellites_db
$ psql satellites_db < satellites_data.sql
  1. Head over to N2YO and register for an account

  2. Create a .env file in the backend directory and add the following environment variables.

SQLALCHEMY_DATABASE_URI=postgresql:///satellites_db
SECRET_KEY=<generate a random string for Flask's secret key>
n2yo_api_key=<add your key here>
  1. Start up the Flask server
(venv)$ flask run
  1. Navigate your preferred browser (Chrome suggested) to http://127.0.0.1:5000/

Contributing

We welcome contributions! Feel free to open a PR and then reach out at the emails below.

Support and Contact

If you want to contact us you can reach us at [email protected], [email protected], and [email protected]

License

This project uses the following license: MIT

Copyright (c) 2020 Matt McFarland

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 40.1%
  • HTML 37.7%
  • JavaScript 17.2%
  • CSS 5.0%