React Pokedex

Pokedex built with ReactJS for Wizeline Academy Course.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

In order to run this project locally, you'll need to have Node 10.13.0 and Yarn installed on your computer.

After installing both tools, open a commando line window and enter the following:

To check that Node was installed correctly, run:

node -v

To check that Yarn was installed correctly, run:

yarn -v

Installing

To install the project locally, you'll have to configure the Backend repository first in order to make the project work correctly. Once everything is configured, follow the next steps:

• Download repository by cloning the repo on your local machine
• Once on your machine, open a terminal/command line on the project folder and execute the following command:

  cp .env.example .env
  

• In order to use all the libraries for the project execute the following command to download the necessary tools:

   yarn
  

• To run the project on the browser, execute the following command, once started, website such be displayed on http://localhost:8080

   yarn run dev-server
  

Lint

If code is not lint (on Javascript or Styles) you can run the following command on the Terminal/Command Line to order the code styling:

For Javascript files:

yarn lint:js

For Styles files:

yarn lint:css

Built With

• React - JS library to create user interfaces
• Styled-Components - CSS to Javascript styles
• React-Router - Collection of navigational components that compose declaratively with applications
• React-Redux - Predictable state container for JavaScript apps.
• Webpack - Static module bundler for modern JavaScript applications
• Dotenv - Zero-dependency module that loads environment variables from a .env file into process.env
• StandardJS - JavaScript style guide, linter, and formatter
• Stylelint - A mighty, modern linter that helps you avoid errors and enforce conventions in your styles
• Lodash - A JavaScript utility library delivering consistency, modularity, performance, & extras

Authors

• Jose Almaraz - Frontend Developer - jalmarazg
• Ruben Saucedo - Frontend Developer - RubenSaucedo
• Angel Martinez - Backend Developer - miickeyreyez