update README.md file

README.md

@@ -1 +1,245 @@
-# space-traveller-s-hub
+<!--
+HOW TO USE:
+This is an example of how you may give instructions on setting up your project locally.
+
+Modify this file to match your project and remove sections that don't apply.
+
+REQUIRED SECTIONS:
+-Project description
+- Table of Contents
+- About the Project
+  - Built With
+  - Live Demo
+- Getting Started
+- Authors
+- Future Features
+- Contributing
+- Show your support
+- Acknowledgements
+- License
+
+OPTIONAL SECTIONS:
+- FAQ
+
+After you're finished please remove all the comments and instructions!
+-->
+
+<div align="center">
+  <!-- You are encouraged to replace this logo with your own! Otherwise you can also remove it. -->
+
+  <br/>
+
+  <h3><b>Space-traveller-s-hub</b></h3>
+
+</div>
+
+
+# 📗 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)
+  - [Deployment](#triangular_flag_on_post-deployment)
+- [👥 Authors](#authors)
+- [🔭 Future Features](#future-features)
+- [🤝 Contributing](#contributing)
+- [⭐️ Show your support](#support)
+- [🙏 Acknowledgements](#acknowledgements)
+- [Video-presentation](#presentation)
+- [❓ FAQ (OPTIONAL)](#faq)
+- [📝 License](#license)
+
+
+# 📖 [Space-traveller-s-hub]
+
+
+ **[Space-traveller-s-hub]** provides commercial and scientific space travel services with the real live data from the SpaceX API.
+
+
+## 🛠 Built With <a name="built-with"></a>
+
+### Tech Stack <a name="tech-stack"></a>
+
+
+
+<details>
+  <summary>Client</summary>
+  <ul>
+    <li><a href="#">CSS</a></li>
+    <li><a href="#">JavaScript</a></li>
+    <li><a href="#">React js</a></li>
+  </ul>
+</details>
+
+<details>
+  <summary>Server</summary>
+  <ul>
+    <li><a href="#">No Server build yet</a></li>
+  </ul>
+</details>
+
+<details>
+<summary>Database</summary>
+  <ul>
+    <li><a href="#">No database build yet</a></li>
+  </ul>
+</details>
+
+
+### Key Features <a name="key-features"></a>
+
+- **[Used Linters]**
+- **[Great summary for the repo]**
+- **[Use of GitFlow]**
+
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+## 💻 Getting Started <a name="getting-started"></a>
+
+A new developer can get the project from my Github repo link i shall provide.
+
+To get a local copy up and running, follow these steps.
+
+
+go to https://github.com/stephenkati/space-traveller-s-hub.git
+
+clone or download the project
+
+Run `npm install`
+Run `npm start`
+
+
+### Prerequisites
+
+In order to run this project you need:
+
+-A code editor, preferably VSCode. Any other code editor is okay.
+
+-Browser
+
+
+### Setup
+
+Clone this repository to your desired folder:
+
+Run `git clone https://github.com/stephenkati/space-traveller-s-hub.git`
+cd `space-traveler-s-hub`
+
+### Install
+
+Install this project with:
+
+Download the project from github and run it in your browser.
+
+Install dependencies.
+`npm install`
+
+
+
+### Usage
+
+To run the project, navigate to the project directory and use a live Server extension in your VSCode to run the project.
+
+Run `npm start` 
+
+
+### Run tests
+
+You can run tests to check for linter errors by running the following commands:
+
+- `npx stylelint "**/*.{css,scss}"` for testing css errors
+- `npx eslint "**/*.{js,jsx}"` for Javascript errors
+
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+## 👥 Authors <a name="authors"></a>
+
+
+👤 **Stephen Katuli**
+
+- GitHub: [@githubhandle](https://github.com/stephenkati)
+- LinkedIn: [LinkedIn](https://www.linkedin.com/in/stephen-katuli/)
+
+👤 **IRADUKUNDA Pacific Rugwizangoga**
+
+- GitHub: [@githubhandle](https://github.com/rugwizangoga)
+- LinkedIn: [LinkedIn](https://www.linkedin.com/in/iradukunda-pacific-rugwizangoga)
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+## 🔭 Future Features <a name="future-features"></a>
+
+
+- [ ] **[More backround images]**
+- [ ] **[Animations and transitions]**
+- [ ] **[More Javascript Functionality]**
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+## 🤝 Contributing <a name="contributing"></a>
+
+Contributions, issues, and feature requests are welcome!
+
+I am very grateful to Zeplin for the design I used.
+
+Feel free to check the [issues page](https://github.com/stephenkati/space-traveller-s-hub/issues).
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+## ⭐️ Show your support <a name="support"></a>
+
+If you like this project please reach out to me on my social media, hire me for more content like this.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+## 🙏 Acknowledgments <a name="acknowledgements"></a>
+
+I would like to thankmy Microverse team and my coding partners for their support and guidance.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+##  PRESENTATION  <a name="presentation"></a>
+
+**PROJECT PRESENTATION VIDEO**
+
+No presentation done yet.
+
+
+
+## ❓ FAQ (OPTIONAL) <a name="faq"></a>
+
+- **[How good are your communication skills?]**
+
+  - [I have good writting and speaking communication skills in English.]
+
+- **[What else do you do apart from coding?]**
+
+  - [I do graphics design.]
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+## 📝 License <a name="license"></a>
+
+This project is [MIT](/LICENSE.md) licensed.
+
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>