- 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
cd pokeapi.coto go into the project root.
npm installto install project dependencies.
npm run developto start the hot-reloading development server (powered by Gatsby).
- Go to
http://localhost:8000to view the site in your browser.
Fork the project
- Fork the project to your own GitHub profile.
- Clone the forked repository onto your local machine.
git pull origin masterto ensure you have the latest main code.
git checkout -b branch-name(replacing branch-name with a suitable name) to create a branch.
Make the change
- Follow the "Running locally" instructions.
- 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.
git add -Ato stage your changed files.
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.
git push my-fork-name branch-nameto push your changes to your own GitHub repository.
Go to the pokeapi.co repo and you should see your recently pushed branches.
Follow GitHub's instructions to submit a pull request.
Describe the changes you made in the body of the PR. If possible, include screenshots of visual changes.