Skip to content

dev-setup.md

Latest commit

 

History

History
91 lines (64 loc) · 1.53 KB

dev-setup.md

File metadata and controls

91 lines (64 loc) · 1.53 KB

Dev Setup (Contributors)

This guide is optimized for getting a new contributor to a working local environment quickly. If you need product context first, start with ../../README.md.

Prerequisites

  • Python 3.10+
  • Node.js 18+

Repo layout

  • backend/ — FastAPI + SQLAlchemy
  • frontend/ — Next.js 14
  • docs/ — documentation

1) Clone

git clone https://github.com/zhuamber370/memlineage.git
cd memlineage

2) Configure env

cp .env.example .env
cp .env frontend/.env.local

Notes:

  • Backend reads backend/.env and root .env.
  • Frontend reads frontend/.env.local.

3) Run backend

See: backend/README.md

Typical local run:

cd backend
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
python3 -m uvicorn src.app:app --reload --port 8000

Verify:

4) Run frontend

See: frontend/README.md

cd frontend
npm install
npm run dev

Verify:

5) Running tests

Backend:

cd backend
python3 -m pytest -q
python3 scripts/cleanup_test_data.py

Frontend:

cd frontend
npm run build

What to contribute first

Good first contributions (high-signal, low-risk):

  • Documentation fixes (API surface sync, README clarity)
  • Small UI copy improvements (keep tone factual)
  • UX polish on /changes diff readability

If you’re unsure, open an issue with:

  • Your preferred area (backend/frontend/full-stack/docs)
  • Your available time (e.g. 30–60 min / weekend)