Microverse README Template

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Crypto App

This is my latest React project, I chose an API from The Crypto Compare which provides me with cryptocurrencies data, and then built my web app using React and Redux. The design guidelines are based on the Ballhead app by Nelson Sakwa

🛠 Built With

• React
• Redux
• HTML/CSS & JavaScript best practices: Correct use of tags, elements, properties and syntax.
• Linters Check: Local and Pull Request check for errors, bugs and stylistic errors in code.
• Gitflow
• Unit tests

Key Features

• Display a list of the top 10 cryptocurrencies
• Display the coin information

(back to top)

🚀 Live Demo

• Live Demo Link
• Loom Video Pesentation

(back to top)

💻 Getting Started

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

Prerequisites

• Have a source code editor such as VSCode
• Install nodeJS along with NPM

Setup

• Clone this repository into your local environment with git clone https://github.com/vvoo21/Space-Travelers-Hub.git

Install

• Just run npm i on the root of the project and you're good to go. All of the necesary packages will be installed for you!

Run tests

• Run npm start to se a live version of the project on your browser
• Run npx hint . to get Webhint going, a linter for HTML
• Run npx stylelint --fix "**/*.{css,scss}" to get Stylelint going, a linter for CSS
• Run npx eslint --fix . to get ESLint going, a linter for JS

Deployment

• Run npm run build for Webpack to generate the dist files corresponding to your actual /src files

(back to top)

👥 Author

👤 Vanessa Oliveros Padron

• GitHub: @vvoo21
• Twitter: @vaneoliverosp
• LinkedIn: vaneoliverosp

(back to top)

🔭 Future Features

• Redux Toolkit
• Jest testing
• React Router

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

🤗 Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

• I would like to thank the Microverse program!
• I would like to thank anyone whose code was used!
• Original design idea by Nelson Sakwa on Behance.

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)