Giter VIP home page Giter VIP logo

pokedex's Introduction

Pokédex

Table of contents:

About the project:

Pokedex developed with React Native, consuming the public API: Pokeapi.

Objective:

Technologies

✅ React Native
✅ Native Base
✅ Styled-components
✅ Axios
✅ React-native-linear-gradient
✅ SWR
✅ React-navigation
✅ Context API
✅ Lottie
✅ Git-commit-msg-linter
✅ React-native-animatable
✅ React Hooks
✅ Babel-plugin-root-import
✅ Vector Icons
✅ react-native-fast-image
✅ Animated
✅ Typescript
✅ Jest
✅ @testing-library/jest-native
✅ @testing-library/react-hooks
✅ @testing-library/react-native

Prerequisites

Before proceeding, it is ideal that you have the environment set up to create applications in React Native, for this you can follow the guide of the link below:

React Native's Environment (Android/iOS)

Getting started

First you clone the project:

$ git clone https://github.com/MRLSK8/Pokedex.git && cd Pokedex

Then you run the following command to install packages:

$ yarn install

Next, you start the project:

$ yarn start

Finally you run it like so:

$ yarn android

If you want to build it and generate an APK just do the following

$ yarn android:build

It will generate an APK on android/app/build/outputs/apk/app-release.apk, copy into your cellphone and install it.

And that's it!

Running Tests

You just need to run this command:

  $ yarn test

In order to check the tests coverage out, run this command instead:

  $ yarn test:coverage

File structure

The file structure are in the following way:

├── src/
│   ├── @types/
│   │   └── index.d.js
│   ├── assets/
│   │   └── LottieJsonFiles
│   │       ├── pikachu.json
|   |       └── pokeball.json
│   ├── components/
│   │   ├── GoBackButton/
|   |   |   ├── index.tsx
|   |   |   └── style.ts
|   |   ├── LoadingWrapper/ 
|   |   |   ├── index.tsx
|   |   |   └── style.ts
│   │   ├── PokemonItem/
|   |   |   ├── index.tsx
|   |   |   └── style.ts
|   |   ├── SafeAreaWrapper/ 
|   |   |   ├── index.tsx
|   |   |   └── style.ts
│   │   └── index.ts
│   ├── config/
│   │   └── statusBarConfig.ts
│   ├── hooks/
│   │   └── pokemonContext.tsx
│   ├── routes/
│   │   └── index.ts
│   ├── screens/
│   │   ├── PokemonDetails/
|   |   |   ├── index.tsx
|   |   |   └── style.ts
|   |   ├── PokemonsList/ 
|   |   |   ├── index.tsx
|   |   |   └── style.ts
│   │   └── index.tsx
│   ├── services/
│   │   └── api.ts
│   ├── utils/
│   │   ├── addPadLeftToNumber.ts
│   │   ├── getPokemonIdByUrl.ts
│   │   ├── getPokemonImageById.ts
│   │   ├── index.ts
│   │   └── showErrorAlert.ts
│   ├── index.tsx
├── .buckconfig
├── .editorconfig
├── .eslintrc.js
├── .eslintrc.json
├── .gitattributes
├── .gitignore
├── .prettierrc.js
├── .watchmanconfig
├──  app.json
├── babel.config.js
├── index.js
├── LICENSE
├── metro.config
├── package.json
├── react-native.config.js
├── tsconfig.js
├── yarn.lock

License:

This project is licensed under the MIT License - see the LICENSE file for details.

Contact:

Facebook | Instagram | Linkedin

Made with ❤️ by Marcelo Lima 😊

pokedex's People

Contributors

mrlsk8 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.