https://github.com/codewithalihamza/humble-supperhero-frontend
https://github.com/codewithalihamza/humble-supperhero-frontend
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/codewithalihamza/humble-supperhero-frontend
- Owner: codewithalihamza
- Created: 2025-02-07T18:28:44.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2025-02-07T19:20:11.000Z (over 1 year ago)
- Last Synced: 2025-02-07T20:19:50.705Z (over 1 year ago)
- Language: TypeScript
- Size: 172 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## **đź“ś README for Frontend (React App)**
```md
# 🎨 Humble Superhero Frontend (React)
This is the **React frontend** for the **Humble Superhero API**. It provides an interface where users can add superheroes and see the sorted list in real time.
---
## 🚀 Features
- **Add Superheroes:** Users can enter superhero details and submit them to the backend.
- **Fetch & Display Data:** Fetches superheroes sorted by humility.
- **Validation:** Prevents invalid entries (e.g., humility scores beyond 1-10).
- **Responsive UI:** Works well on mobile and desktop.
---
## 🛠️ Tech Stack
- **React (with TypeScript)** - Frontend library.
- **Vite** - For fast development.
- **Axios** - For API requests.
- **Tailwind CSS** - For styling.
---
## 🔧 Installation & Running the Project
1. **Navigate to the frontend folder:**
```sh
cd humble-supperhero-frontend
```
2. **Install dependencies:**
```sh
npm install
```
3. **Start the frontend:**
```sh
npm run dev # Vite
```
---
## đź“Ś How It Works
1. Enter superhero **name**, **superpower**, and **humility score**.
2. Click **"Add Superhero"** to submit.
3. The list updates automatically, sorted by humility score.
---
## âś… **Technical Skills**
- **React + TypeScript:** Ensures type safety.
- **API Integration:** Uses `axios` to interact with NestJS backend.
- **State Management:** Uses React Hooks (`useState`, `useEffect`).
- **Error Handling:** Handles API errors gracefully.
---
## 🤝 **Team Player Attitude**
> If working with a teammate, I would:
1. **Component-Based Approach:** Break UI into reusable components.
2. **Separate Concerns:** Keep API calls in a service file.
3. **Code Reviews:** Ensure best practices in PRs.
4. **Design Consistency:** Use Tailwind CSS for uniform styling.
---
## 🧠**If I Had More Time...**
If I had more time, I would:
1. **Improve UI:** Use Material UI or Ant design for better styling.
2. **Real-Time Updates:** Implement WebSockets for instant updates.
3. **Error Alerts:** Add Toast notifications for better UX.
---
## 🎤 **Humility and Communication**
- **Clear Code & Comments:** The project is easy to understand.
- **Simple Setup Instructions:** Anyone can run it easily.
- **Designed for Collaboration:** Component-based structure for teamwork.
---
## 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 the browser.
The page will reload if you make edits.\
You will 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.
### `npm run eject`
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).