Skip to content
The PokéAPI documentation website
Branch: master
Clone or download
Naramsim Spelling Fix on "Permanently" (#60)
Spelling Fix on "Permanently"
Latest commit d605e64 May 9, 2019

README.md

pokeapi.co

code style: prettier

This repository contains the source code and documentation for pokeapi.co. This website is built on Gatsby and includes a netlify.toml file for deployment on Netlify.

Getting Started

Prerequisities

  • Git
  • Node: 10.11.0 or greater
  • A fork of the repo (for any contributions)
  • A clone of the pokeapi.co repo on your local machine

Installation

  1. cd pokeapi.co to go into the project root.
  2. npm install to install project dependencies.

Running locally

  1. npm run develop to start the hot-reloading development server (powered by Gatsby).
  2. Go to http://localhost:8000 to view the site in your browser.

Contributing

Fork the project

  1. Fork the project to your own GitHub profile.
  2. Clone the forked repository onto your local machine.
  3. git pull origin master to ensure you have the latest main code.
  4. git checkout -b branch-name (replacing branch-name with a suitable name) to create a branch.

Make the change

  1. Follow the "Running locally" instructions.
  2. Save the files and check results in the browser.

Changes to React components in src will hot-reload. If working with plugins, you may need to remove the .cache directory and restart the server.

Test the change

If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile.

Push it

  1. git add -A to stage your changed files.

  2. git commit -m "My message" (replacing My message with a commit message, such as "Fix header logo on Android") to commit your changes.
    While not critically important, try to follow the guidelines in How to Write a Git Commit Message.

  3. git push my-fork-name branch-name to push your changes to your own GitHub repository.

  4. Go to the pokeapi.co repo and you should see your recently pushed branches.

  5. Follow GitHub's instructions to submit a pull request.

  6. Describe the changes you made in the body of the PR. If possible, include screenshots of visual changes.

You can’t perform that action at this time.