jorgeabrahan/superheroes

Superheroes web application built in React using private and public routes, context for user authentication and query params to preserve searches.

📗 Table of Contents

• 📗 Table of Contents
• 📖 hello-react-front-end
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 SuperHeroes

SuperHeroes web application built in React using private and public routes, context for user authentication and query params to preserve searches.

Tests running

🛠 Built With

Tech Stack

Client

• html
• css
• JavaScript/ES6
• React

Server

• N/A

Database

• N/A

Key Features

• Public and private routes
• Mock of routes authentication
• Preserve last visited page when the user logs out

(back to top)

🚀 Live Demo

https://superheroes-1ut5.onrender.com/

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Git SCM
• Visual Studio Code
• Live Server extension

Setup

Clone this repository to your desired folder:

git clone https://github.com/jorgeabrahan/superheroes .git

Or download the ZIP folder.

Install

Once you've cloned the repository simply run:

cd superheroes
npm i

And if you want to analyze the code you can run:

code .

To open the project in VScode

Usage

To run the project, if you are on the hello-react-front-end folder path on your terminal you can execute the following command:

npm start

Run tests

To run tests:

npm run test

Deployment

npm run build

(back to top)

👥 Authors

👤 Jorge Abrahan

• GitHub: @jorgeabrahan
• LinkedIn: Jorge Abrahan

(back to top)

🔭 Future Features

• Retreive data from an API

(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 just cheer me up with a comment 🙂!

(back to top)

🙏 Acknowledgments

No acknowledgments needed so far!

(back to top)

❓ FAQ

• What is this project main purpose?

  • To practice working with React, Authentication, and React router private and public routes

(back to top)

📝 License

This project is MIT licensed.

(back to top)