PokeWiki

This project is a Pokédex based on the anime and games Pokémon.

This project was bootstrapped with Create React App.

You can access PokeWiki here: GitHub Pages.

💎 Stack

This project uses ReactJS as the main lib, bootstraped with create-react-app. The styling is done with css-modules and the automated tests with jest + testing-library.

I'm using yarn as the package manager, GitHub Pages to render the app, React Redux to manage the state of the application, Redux Sagas to make application side effects and @FormatJs/React-Intl to manage the internationalization of the application

📋 Requirements

• NodeJS (LTS is fine);
• yarn - it can be installed as a npm package or you can follow the instructions on the official website.

🏁 How to start

You need have node 12+ installed in your machine.

1. Clone this project:

git clone [email protected]:luisfagottani/pokewiki.git

2. Install dependencies:

$ yarn

3. Run the project:

$ yarn start

🔬 Testing

Was used testing library and jest to create unit tests in the application. If you want run manually, run the following command:

$ yarn test

🔨 Building

To building the project, run the following commands:

$ yarn build

🚀 Deploying

This project uses gh-pages from GitHub as hosting. After making your changes, you need run:

$ yarn deploy:publish

This command will make the automatic deploy of the branch gh-pages and your site will be automatically published.