README.md

Marvel Appp

The Marvel Comics APA allows you to access information about Marvel's vast library of characters what's coming up, to 70 years ago.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Search for your favorite character, with this application you can find details and statistics of your favorite MARVEL character.

• Free access to MARVEL character information
• Current characters
• Easy use with basic and helpful information

This project was developed for educational purposes but its features are completely functional.

Built With

• npm
• JavaScript
• HTML
• SCSS
• Grommet
• Axios
• React
• Styled Components
• Enzyme
• Jest
• MARVEL API
• More Information about dependences

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

npm install npm@latest -g

Installation

1. Get Public and Private Key at https://developer.marvel.com//

2. Clone the repo

git clone https:://github.com/SantiagoGuerra/marvel-app.git

3. Install NPM packages

npm install

4. Go to the .env.example file
5. Rename the .env.example file to .env
6. Inside the .env file put your public and private keys:

  REACT_APP_PUBLIC_KEY='YOUR PUBLIC KEY' 
  REACT_APP_PRIVATE_KEY='YOUR PRIVATE KEY'
  ...

7. Start

  npm start

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Santiago Guerra - @dedalo_g - [email protected]

Project Link: https://github.com/santiagoguerra/marvel-app

Acknowledgements

• Microverse
• Microverse TSEs
  • Sérgio Torres da Silveira Filho
  • Louis Chia
  • James Okunlade