Skip to content

Latest commit

 

History

History
107 lines (56 loc) · 3.41 KB

README.md

File metadata and controls

107 lines (56 loc) · 3.41 KB
Raw

Pokemon World

This project is a web application based on an external API that allows getting basic information and pictures about any kind of pokemon. You can post your comments on the pokemon profile and give it likes. The comments and the likes features are stored in another API.

What was build in this part of the project:

  • Use Webpack dependencies for better JS and CSS file performance.

  • Bootstrap 5.

  • Font awesome 5.

  • Pokemon API features.

  • Involement API features.

Image Preview

Screenshot Main Page

🎥 Video Presentation

⭐ Live Demo ⭐

Getting Started

To get a local copy up and running follow these simple example steps:

  • On the project, GitHub page, navigate to the main page of the repository

  • Click on a button named Code

  • Copy the project URL as displayed on HTTPS tab

  • If you're running Windows Operating System, open your command prompt. On Linux, Open your terminal

  • Change the current working directory to the location where you want the cloned directory to be made. Leave as it is if the current location is where you want the project to be.

  • Type git clone, and then paste the URL you copied in Step 3.

    $ git clone https://github.com/mrigorir/Pokemon-world Press Enter key

  • Your local copy will be created.

  • Please note that you must have Git installed on your PC, this can be done here

  • After you get the project aiming to the desired directory, you need now to install ruby globally and follow the steps below:

Github Actions

To make sure the linters' checks using Github Actions work properly, you should follow the next steps:

  1. On your recently forked repo, enable the GitHub Actions in the Actions tab.

  2. Create the feature/branch and push.

  3. Start working on your milestone as usual.

  4. Open a PR from the feature/branch when your work is done.

Usage

  • Make sure you have npm and node installed in your terminal.

  • I recommend the use of VS code as a code editor, but you can use whatever you want.

  • Run in your terminal npm run start to see webpack html file in action.

  • Run npm install express in case you get the error after running the server.

  • You can see the pokemons cards when the page loads.

  • If you click the info button, you can see the profile, and post a comment.

  • You can click the heart button to leave your like.

Authors

👤 Marco Parra

👤 Mih Julius

🤝 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!

Acknowledgments

  • Microverse Activities

📝 License

This project is MIT licensed.