ReactJs --> [Superheroes-catalogue App]

This is a Superheroes-catalogue app built with React.
Explore the docs »

Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
  • Usage
  • Automated Test
• Contributors
• Acknowledgements
• License

About The Project

The Superheroes-catalogue is a capstone project based on a catalog of statistics that is a browsable list of items and can be filtered and accessed the details of one item. The WebApp it has two types of pages, the main one with the list of elements to display and the second one with a single element displaying relevant information about that object. Each page has a unique route within the Single Page Application. The project retrieves data from an API and stores it in the Redux Store. Based on that API it is possible to filter the data using a Filter stateless component.

Built With

This project was built using these technologies.

• HTML/CSS
• ReactJs
• JavaScript
• Heroku Buildpack
• ESLint
• StyleLint
• GithubActions 💪

Usage

To have this app on your pc, you need to:

• download or clone this repo:

  • Clone with SSH:

    git@github.com:vzdrizhni//Superheroes-catalogue.git
  

  • Clone with HTTPS

    https://github.com/vzdrizhni//Superheroes-catalogue.git
  

• In the project directory, you can run:

  • $ yarn install - installs all the dependencies required by the project

  • $ yarn start - runs the app in the development mode:

    • Open 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.

  • $ yarn test

    • Launches the test runner in the interactive watch mode.
    • See the section about running tests for more information.

  • $ yarn 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!

Automated Test

• $ yarn test
  • Launches the test runner in the interactive watch mode.
    
  • See the section about running tests for more information.

Live Demo & Deployment

The project has been deployed with Github Pages.

Heroku Live Demo Link 👈

WalkThrough Video:

https://www.loom.com/share/247c5bf9e10e4c40a41de4c2a186b64f

Contributors

👤 Roman Nikolaev

• LinkedIn: [Roman Nikolaev]https://www.linkedin.com/in/romannikolaev/)
• GitHub: vzdrizhni
• E-mail: vzdrizhni@gmail.com

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐ if you like this project!

Acknowledgements

• Microverse
• The Odin Project
• React Documentation
• Heroku Documentation
• Heroku Buildpack

📝 License

This project is MIT licensed.