https://github.com/ashmalzahra/space-travelers-hub

This project is a Single Page Application(SPA) that has been built working with real live data from SpaceX API. A web application for a company that provides commercial and scientific space travel services. The application will allow users to book rockets and join selected space missions. Built with React and Redux.
https://github.com/ashmalzahra/space-travelers-hub

best-practices code-review deployment events react react-router react-testing-library redux redux-thunk unit-testing

Last synced: 19 days ago
JSON representation

This project is a Single Page Application(SPA) that has been built working with real live data from SpaceX API. A web application for a company that provides commercial and scientific space travel services. The application will allow users to book rockets and join selected space missions. Built with React and Redux.

• Host: GitHub
• URL: https://github.com/ashmalzahra/space-travelers-hub
• Owner: ashmalzahra
• License: mit
• Created: 2023-03-06T20:35:41.000Z (almost 2 years ago)
• Default Branch: develop
• Last Pushed: 2023-04-13T22:51:47.000Z (over 1 year ago)
• Last Synced: 2024-12-06T03:44:41.312Z (about 1 month ago)
• Topics: best-practices, code-review, deployment, events, react, react-router, react-testing-library, redux, redux-thunk, unit-testing
• Language: JavaScript
• Homepage:
• Size: 1.15 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




   
Space Traveler's Hub



# 📗 Table of Contents

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

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

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

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

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

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

- [👥 Authors](#authors)

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#license)

# 📖 Space Travelers' Hub

This SPA(Single Page Application) is created using real live data from the SpaceX API. A web application for a company that provides commercial and scientific space travel services. The application will allow users to book rockets and join selected space missions. The Space Travelers' Hub consists of Rockets, Missions, and the My Profile section.

## Built With

- React.js

- Redux Toolkit

- VSCode and GitHub

- SpaceX API endpoints: 

    - Rockets: https://api.spacexdata.com/v4/rockets

    - Missions: https://api.spacexdata.com/v3/missions

### Tech Stack 

  Client

  


    


React to create the UI.

    


Redux Toolkit to manage state.

    


Tailwindcss to apply awesome styles.

  


  Server

  


    
SpaceX Missions API

    
SpaceX Rockets API

  


Database

  


    
N/A

  


(back to top)


### Key Features

- **[Git Flow]**

- **[React Router]**

- **[Unit tests with React Testing Library]**

(back to top)


## Live Demo

[Live Demo Link](https://space-travelers-hub-ruuk.onrender.com/)

## 💻 Getting Started

Clone this repository to get started with the project, make sure to configure linters by following the instructions in the [Linters README file](https://github.com/microverseinc/linters-config/blob/master/README.md)

### Prerequisites

In order to run this project you need:

- A working computer.

- Connection to internet.

- [npm](https://www.npmjs.com/) and [Node.js](https://nodejs.org/en/) installed, if you don't have them, please follow this [simple installation guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).

### Setup

- Clone the folder to your local machine.

- Open a local copy of the project in your code editor.

(back to top)


### Usage

- To run the project, execute the following command:

    - npm start in your terminal.

- To run test functions, execute the following command:

    - npm test in your terminal.

(back to top)


### Run tests

- After pushing the changes on github, merge your pull request and let github action process changes and fix errors, if any.

  - For stylelint errors run:npx stylelint "**/*.{css,scss}" --fix for automatic fix.

  - For ESLINT errors run:npx eslint "**/*.{js,jsx}" --fix for automatic fix.

(back to top)


## 👥 Authors

👤 **Ashmal Zahra**

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

- Twitter: [@AshmalZahraa](https://twitter.com/AshmalZahraa)

- LinkedIn: [ashmal-zahra](https://www.linkedin.com/in/ashmal-zahra)

👤 **Emmanuel Balikuddembe**

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

- Twitter: [@twitterhandle](https://twitter.com/BalixEmma)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/emmanuelbalikuddembe/)

(back to top)


## 🔭 Future Features 

- [ ] **Advanced styling**

- [ ] **Animations**

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/ashmalzahra/space-travelers-hub/issues).

(back to top)


## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse for the information provided to build this project.

(back to top)


## ❓ FAQ (OPTIONAL) 

- **Can I use the project for any purpose?**

  - Yes, you can.

- **Is the information saved in any database?**

  - No, all data is saved in Local Storage.

(back to top)


## 📝 License

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

(back to top)