https://github.com/sebalp100/metrics-webapp

Simple website that allows users to search for all the moons in the solar system, using real data from The Solar System OpenData API. Made with React and Redux.
https://github.com/sebalp100/metrics-webapp

javascript react redux

Last synced: 17 days ago
JSON representation

Simple website that allows users to search for all the moons in the solar system, using real data from The Solar System OpenData API. Made with React and Redux.

• Host: GitHub
• URL: https://github.com/sebalp100/metrics-webapp
• Owner: sebalp100
• License: mit
• Created: 2023-01-08T16:09:49.000Z (almost 2 years ago)
• Default Branch: dev
• Last Pushed: 2023-01-12T21:51:45.000Z (almost 2 years ago)
• Last Synced: 2024-10-09T07:41:35.075Z (about 1 month ago)
• Topics: javascript, react, redux
• Language: JavaScript
• Homepage:
• Size: 1.03 MB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        









  
Moons of the Solar system




# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

    - [Future Features](#future-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Usage](#usage)

  - [Run tests](#run-tests)

- [👥 Authors](#authors)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 Moons of the Solar system 

> In this project, we are setting up website that allows users to search for all the moons in the solar system, using real data from The Solar System OpenData API.

## 🛠 Built With 

### Tech Stack 

  Building

  


    
JavaScript

    
HTML 5

    
CSS 3

    
ES6

    
React

    
Redux

  


  Bundle

  


    
WebPack

    
NPM

  


  Server

  


    
React server

  


### Key Features 

- Search Planet

- Display Planets

- Display Moons

- Display number of Moons

- Display planet gravity

### Future Features 

- Improve style

- Specific data for each moon

- Search Moon

- User interactions (leaving comments)

(back to top)


## 🚀 Live Demo 

[Click Me](https://moons-of-the-solar-system.onrender.com/)

(back to top)


## 💻 Getting Started 

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

- Github account.

- Code editor (Visual Studio Code, Atom, etc.)

### Setup

Clone this repository to your desired folder:

- cd my-folder

- git clone https://github.com/sebalp100/Metrics-webapp/

### Install

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

## Available Scripts

In the project directory, you can run:

### `npm start`

Runs the app in the development mode.\

Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\

You may also see any lint errors in the console.

### `npm test`

Launches the test runner in the interactive watch mode.\

See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

Builds the app for production to the `build` folder.\

It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\

Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### Usage

To run the project, execute the following command:

`npm install`

`npm start`

### Run tests

To run tests, run the following command:

`npm test`

(back to top)


## 👥 Authors 

👤 **Sebastian Martin**

- GitHub: [@sebalp100](https://github.com/sebalp100)

- LinkedIn: [Sebastian Martin](https://www.linkedin.com/in/sebastian-martin-956b2724a/)

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

Give a ⭐️ if you like this project!

(back to top)


## 🙏 Acknowledgments 

- Hat tip to anyone whose code was used

- Paul Nasilele for his search bar tutorial

- Freepik, Turkkub and Monkik for their icons (https://www.flaticon.com/authors/freepik, https://www.flaticon.com/authors/turkkub, https://www.flaticon.com/authors/monkik)

- Nelson Sakwa for their design (https://www.behance.net/sakwadesignstudio)

- Microverse

(back to top)


## 📝 License 

This project is [MIT](./LICENSE) licensed.

(back to top)