Stephen-Adom/star-wars-hub

Explore the Star Wars universe with our information-packed website. From characters to planets and starships, delve into detailed insights seamlessly

Star Wars Hub

Table of Contents

• Table of Contents
• StarWarsHub
  • Built With
    • Tech Stack
    • Key Features
  • 🎹 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
  • Author
  • Future Features
  • Contributing
  • ⭐️ Show your support ⭐️
  • Acknowledgments
  • 🎼 License 🎼

---

StarWarsHub

Explore the Star Wars universe with our information-packed website. From characters to planets and starships, delve into detailed insights seamlessly

(back to top)

Built With

Tech Stack

Client Side

• Angular
• Primeng
• RxJS

Styling

• Tailwind CSS

State Management

• NgRx

(back to top)

Key Features

• Home page with at least 3 slides
• Lister page with table. 10 rows per page with paginator
• Details page with details of each character
• Navigation bar with logo, lister page link and search bar
• Footer with logo and copyright text

(back to top)

💻 Getting Started

Prerequisites

To run this project, you need the following:

• A web browser (Safari, Chrome, Opera, etc...)
• A code editor (Sublime Text, VS Code, WebStorm, etc...)
• Necessary packages (git, node and npm)

Check if the packages are installed by running the following command in the terminal:

$ git --version
$ node --version
$ npm --version

(back to top)

Setup

Clone this repository into your desired folder by following the following steps.

Install

In the terminal, go to your file directory and run this command:

$ cd my-folder
$ git clone https://github.com/Stephen-Adom/star-wars-hub.git
$ cd star-wars-hub
$ npm install

Initialize

In the terminal run this command:

$ npm start

The website will automatically start on your default web browser.

(back to top)

👥 Author

Stephen Addae

• GitHub: @Stephen-Adom
• LinkedIn Stephen Addae

(back to top)

🔭 Future Features

• Light and dark theme feature
• User Profile Page

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project you can give it a star, that would be nice.

(back to top)

🙏 Acknowledgments

• I would like to thank SWAPI for providing the api for this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)