andrealvesaraujo / Riot-Game

Seventh Dev Challenge of Codelândia: Riot Game Page

Riot-Game

Seventh Dev Challenge of Codelândia: Riot Game Page
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Contact
7. Acknowledgments

About The Project

• Figma Prototype:

https://www.figma.com/file/Yb9IBH56g7T1hdIyZ3BMNO/Desafios---Codel%C3%A2ndia?node-id=10048%3A3

(back to top)

Built With

• React.js
• Sass
• Cypress
• Typescript

(back to top)

Getting Started

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

Prerequisites

• Node Download and install in https://nodejs.org/en/

• npm

  npm install npm -g

Installation

1. Clone the repo

   git clone https://github.com/andrealvesaraujo/Riot-Game.git

2. Install NPM packages

   npm install

(back to top)

Usage

1. Run React

   npm start 

2. Test Cypress on UI

   npx cypress open 

3. Test Cypress on CLI

   npx cypress run

(back to top)

Roadmap

• Create React with Typescript and SASS Project
• Add reset, images, fonts, icons in projet
• Finished Desktop
  • Add HTML semantic
  • Use images, fonts and icons
  • Add flex/grid positioning
• Finished Mobile
  • Add media queries
  • Update positions and images
• Create component of characters cards
• Add feature of sharing page on click of share icon
• Add Cypress Tests
• Add click in card to change main image character
• Optimize performance(Lighthouse)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

Contact

Andre Alves de Araújo - Linkedin - [e-mail]

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• Designer Iuricode
• Img Shields
• React Icons

(back to top)