Skip to content

Commit 0948ed2

Browse files
committed
Node.js and python versions pinned
Signed-off-by: anuunchin <88698977+anuunchin@users.noreply.github.com>
1 parent 9c889fb commit 0948ed2

File tree

4 files changed

+23
-8
lines changed

4 files changed

+23
-8
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,20 +89,30 @@ Before you can run the project locally, install the required tools:
8989

9090
#### Prerequisites
9191

92-
**Node.js 20+** (for frontend)
92+
**Node.js 20** (for frontend)
93+
94+
Recommended: Use [nvm](https://github.com/nvm-sh/nvm) to manage Node.js versions:
9395
```bash
94-
brew install node@20
96+
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
97+
98+
cd src/frontend
99+
nvm install # Installs Node.js 20
100+
nvm use # Switches to Node.js 20
95101
```
96102

97-
**Python 3.11+** (for backend)
103+
Alternative (without nvm):
98104
```bash
99-
brew install python@3.11
105+
brew install node@20
100106
```
101107

108+
**Python 3.11** (for backend)
109+
110+
The Makefile will automatically install Python 3.11 via `uv`. You just need `uv` installed:
111+
102112
**uv** (Python package manager)
103113
```bash
104114
curl -LsSf https://astral.sh/uv/install.sh | sh
105-
# or on mac
115+
# or on macOS
106116
brew install uv
107117
```
108118

@@ -142,8 +152,7 @@ Linting catches code issues and enforces style guidelines. Always run before pus
142152
```bash
143153
make lint # Lint all components (includes type checking)
144154
make lint-frontend # Lint frontend with ESLint
145-
make lint-backend # Lint backend with Ruff
146-
make type-check-backend # Type check backend with mypy
155+
make lint-backend # Lints and type checks backend with Ruff
147156
```
148157

149158
Before you push your changes, run `make lint` and address any errors.

Makefile

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,12 @@ dev: install
4646
install: install-frontend install-backend
4747

4848
install-frontend:
49+
@echo "Installing frontend dependencies (Node.js 20 required, see .nvmrc)"
4950
cd src/frontend && npm install
5051

5152
install-backend:
52-
cd src/backend && uv venv
53+
cd src/backend && uv python install # Auto-uses .python-version (3.11)
54+
cd src/backend && uv venv # Auto-uses .python-version (3.11)
5355
cd src/backend && uv pip install -r requirements.txt
5456
cd src/backend && uv pip install -r requirements-dev.txt
5557

src/backend/.python-version

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
3.11
2+

src/frontend/.nvmrc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
20
2+

0 commit comments

Comments
 (0)