Skip to content

Commit d055657

Browse files
authored
Revise README for branch move and development notes
Updated README to reflect repository branch change and ongoing development status.
1 parent 0642fc5 commit d055657

1 file changed

Lines changed: 2 additions & 45 deletions

File tree

README.md

Lines changed: 2 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,4 @@
1-
## 🏁 Getting Started with Pokémon Pet Shop
1+
## 🏁 The repo has been moved to the main branch
22

3-
This guide provides the necessary steps to set up and run the entire **Pokémon Pet Shop** application on your local machine.
3+
Leaving this branch open for the time being
44

5-
The project is currently under development. I created a backlog of tickets to address identified issues and integrate planned enhancements.
6-
7-
### 📋 Prerequisites
8-
9-
Before proceeding, ensure you have the following installed. Using the specified versions will prevent the most common setup issues.
10-
11-
| Tool | Requirement | Purpose |
12-
| :---------- | :--------------- | :------------------------------------------------------------------- |
13-
| **Git** | Installed | For cloning the repository. |
14-
| **Node.js** | **Version 24.x** | The required runtime environment. |
15-
| **pnpm** | Installed | The project's package manager, essential for the monorepo structure. |
16-
17-
> **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`.
18-
19-
### 💻 Local Setup
20-
21-
#### 1. Clone the Repository
22-
23-
Clone the project using Git on the command line, or use software to download it to your machine.
24-
25-
#### 2. Install Dependencies
26-
27-
Use `pnpm i` to install dependencies for the project
28-
29-
#### 3. Running the Applications
30-
31-
Run the commands below in seperate terminals to start the apps.
32-
33-
**Backend App**: `npx nx run @pokemon-pet-shop/api:serve:development` (http://localhost:3333/api)
34-
35-
**Web App**: `npx nx run web:serve` (http://localhost:4200/)
36-
37-
-- 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. --
38-
39-
**iOS App**: `npx nx run @pokemon-pet-shop/mobile:run-ios` -- Run iOS simulator
40-
41-
**Android App**: `npx nx run @pokemon-pet-shop/mobile:run-android` -- Run Android emulator
42-
43-
### 🧠 Architecture
44-
45-
To understand the design choices, technology stack, and structure of the application, please take a look at the **Architecture Overview**.
46-
47-
➡️ **Read the full document: [README_ARCHITECTURE.md](./README_ARCHITECTURE.md)**

0 commit comments

Comments
 (0)