Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yusufff/pokedex
Pokémon Encyclopedia
https://github.com/yusufff/pokedex
javascript pokemon react
Last synced: about 1 month ago
JSON representation
Pokémon Encyclopedia
- Host: GitHub
- URL: https://github.com/yusufff/pokedex
- Owner: yusufff
- Created: 2019-08-31T14:55:39.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T08:39:59.000Z (about 2 years ago)
- Last Synced: 2023-08-04T17:08:18.214Z (over 1 year ago)
- Topics: javascript, pokemon, react
- Language: JavaScript
- Homepage: https://pokedex-mw31.onrender.com/
- Size: 2.6 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pokedex
> Pokémon Encyclopedia
## Installing / Getting started
To get started, you need a JavaScript package manager such as [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/).
```shell
git clone [email protected]:yusufff/pokedex.git
cd pokedex/
yarn install
yarn run build
```
This creates a build directory with a production build of your app. Set up your favorite HTTP server to serve this folder so that you can start using production build.
## Developing
### Built With
[React](https://github.com/facebook/react), [Create-React-App](https://github.com/facebook/create-react-app)
### Prerequisites
You need a JavaScript package manager such as [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/) to start developing.
### Setting up Dev
Here's a brief intro about what a developer must do in order to start developing
the project further:
```shell
git clone [email protected]:yusufff/pokedex.git
cd pokedex/
yarn install
yarn start
```
Then open the localhost url that you see on the terminal to see Pokedex.
### Building
When you’re ready to deploy to production, create a minified bundle with:
```shell
yarn test
yarn run build
```
Builds Pokedex for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Pokedex is ready to be deployed.
### Components
Every component folder contains an `index.js` file that exports by default the component and a `styles` folder that contains `css` files with the same name with component's folder.
### Services
Services folder is the folder that we keep our service files such as API, LocalStorage, History etc.
### Routing
Routing is done by `App.js` file in the `src` folder. We use [react-router v4](https://github.com/ReactTraining/react-router) for routing.