Skip to content

Commit

Permalink
Added completed project files
Browse files Browse the repository at this point in the history
  • Loading branch information
AdrianGeorgeM committed Sep 22, 2023
0 parents commit bc21c2e
Show file tree
Hide file tree
Showing 41 changed files with 31,779 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) [2023] [Adrian George]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
124 changes: 124 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
# Star Wars Data Explorer 🌌

![Made with React](https://img.shields.io/badge/Made%20with-React-blue) ![License: MIT](https://img.shields.io/badge/License-MIT-blue)

> Fetch and explore data from the Star Wars universe!
> "In a galaxy far, far away... data was needed!" Get all your Star Wars data in one place.
---

## 📌 Table of Contents

- [Demo](#demo)
- [Features](#features)
- [Technologies](#technologies)
- [Installation](#installation)
- [Usage](#usage)
- [Design Patterns](#design-patterns)
- [Code Comments](#code-comments)
- [Future Improvements](#future-improvements)
- [Author](#author)
- [License](#license)

---

## 🌟 Demo

![Demo GIF](https://i.imgur.com/your-demo-gif.gif)

👉 Check it out ([Link](https://recordit.co/R6JH9LsWLw))

---

## 🎉 Features

- **User Input:** Fetch starships, films, or vehicles based on user search queries.
- **Data Display:** Show detailed information about each starship, film, or vehicle.
- **Sorting:** Sort results by name or title.
- **Responsive:** Built with a responsive grid layout.
- **Error Handling:** Graceful error handling with user-friendly messages for any issues like network errors or invalid input.
- **Loading State:** Provides a loading message or spinner to indicate data fetching in progress.

---

## 🚀 Technologies & Tools 🔧

> Unleashing the Power of Modern Web Technologies!
<div align="center">

| ![React](https://img.icons8.com/plasticine/100/000000/react.png) | ![CSS](https://img.icons8.com/color/100/000000/css3.png) |
|:---:|:---:|
| [React](https://reactjs.org/) - The UI Building Block | [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS) - Styling Like a Pro |

</div>

- **React**: Bringing you the _ultra-responsive_ user interface and _state-of-the-art_ frontend functionalities.
- **CSS**: Providing the _visual flair_ and _adaptive layouts_ that make your user experience delightful.



---

## 🔨 Installation

```bash
# Clone the repo
git clone https://github.com//.git

# Navigate to the project directory
cd star-wars-data-explorer

# Install dependencies
npm install

# Start the app
npm start
```

---

## 🎮 Usage

1. Open the app and enter your search query for starships, films, or vehicles.
2. View detailed information about each item in a responsive grid layout.
3. Use the sorting dropdown to sort items by name or title.

---

## 🛠 Design Patterns

- **Componentization:** Utilized React components for maintainability and reusability.
- **State Management:** Made use of React hooks for local state management.
- **Fetch API Abstraction:** Created custom hooks for fetching data from the Star Wars API.

---
## Code Comments

The codebase contains comments to explain the functionality and purpose of different components and functions. Comments have been added to improve code readability and understanding.

---

## 💡 Future Improvements

> What's on the Horizon? 🌅
- **Routing & Details Page**: Add routes for details pages with React Router to showcase individual Star Wars entities like starships, vehicles, or films.
- **User Authentication**: Implement user login to save favorite Star Wars characters or starships.
- **Enhanced Sorting & Filtering**: Add filters to sort by Star Wars era, film appearance, and others.
- **Automated Testing**: Introduce basic unit tests for essential functionalities.
- **Star Wars Quiz**: Implement a Star Wars trivia quiz based on the data from the API.
- **Character Match**: Build a feature that matches you with a Star Wars character based on a short questionnaire.

---

## 📝 Author

- [Adrian]([https://github.com/AdrianGeorgeM](https://github.com/AdrianGeorgeM))

---

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

```
Loading

0 comments on commit bc21c2e

Please sign in to comment.