This guide provides the necessary steps to set up and run the entire Pokémon Pet Shop application on your local machine.
The project is currently under development. I created a backlog of tickets to address identified issues and integrate planned enhancements.
Before proceeding, ensure you have the following installed. Using the specified versions will prevent the most common setup issues.
| Tool | Requirement | Purpose |
|---|---|---|
| Git | Installed | For cloning the repository. |
| Node.js | Version 24.x | The required runtime environment. |
| pnpm | Installed | The project's package manager, essential for the monorepo structure. |
Tip: If you use a Node Version Manager (like nvm or Volta), you can quickly switch to the correct version with a command like
nvm install 24.
Clone the project using Git on the command line, or use software to download it to your machine.
Use pnpm i to install dependencies for the project
Run the commands below in seperate terminals to start the apps.
Backend App: npx nx run @pokemon-pet-shop/api:serve:development (http://localhost:3333/api)
Web App: npx nx run web:serve (http://localhost:4200/)
-- Additional instructions will be added for the native apps in the future. Note: A decent amount of work is still needed but certain elements are rendering. --
iOS App: npx nx run @pokemon-pet-shop/mobile:run-ios -- Run iOS simulator
Android App: npx nx run @pokemon-pet-shop/mobile:run-android -- Run Android emulator
To understand the design choices, technology stack, and structure of the application, please take a look at the Architecture Overview.
➡️ Read the full document: README_ARCHITECTURE.md