Skip to content

spacelabdev/Exoplanetarium-3D

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Purple planet over starry background

About Exoplanetarium 🪐

Spacelab is a project with the goal to explore NASA/CallTech data from the TESS, Kepler and K2 Missions using various degrees of Machine Learning and Deep Natural Networks in the pursuit of Earth-Like planets around nearby stars in the Milky Way Galaxy.

Our short-term goal is to find objects on interest for professional Astronomers to explore, and to classify already-identified candidates that have not yet been classified as either exoplanets or false-positives by the astronomical community.

You can check out the Exoplanetarium app here: https://spacelabdev.github.io/Exoplanetarium-3D/ 🚀🔭⭐🪐

Built With

  • React.js
  • Three.js

Getting Started

To get a local copy, follow these steps.

Prerequisites

Make sure you have the latest npm package installed.

$ npm install npm@latest -g

Installation

  1. Get a free API Key at https://example.com/
  2. Clone the repo.
git clone https://github.com/spacelabdev/Exoplanetarium-3D
  1. Install npm packages.
npm install
  1. Enter your API in config.js
const API_KEY = 'ENTER YOUR API';

Contributing

If you wish to become a contributor to the project, please contact us. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "suggestion".

  1. Fork the Project
  2. Create your Feature Branch
git checkout -b feature/AmazingFeature
  1. Commit your Changes
git commit -m 'Add some AmazingFeature'
  1. Push to the Branch
git push origin feature/AmazingFeature
  1. Open a Pull Request

Deploying to Github Pages

  1. Update the Hompage Property in package.json

Change the homepage property from

"homepage": "./public/index.html",

to

"homepage": "https://spacelabdev.github.io/Exoplanetarium-3D",
  1. Deploy to GitHub Pages
npm run deploy

Note: When developing, the homepage property will need to be switched back to

"homepage": "./public/index.html",