Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified .DS_Store
Binary file not shown.
Binary file added .github/.DS_Store
Binary file not shown.
29 changes: 29 additions & 0 deletions API.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# API Documentation

Base URL (local): `http://localhost:8000`

- OpenAPI UI: `http://localhost:8000/docs`
- OpenAPI JSON: `http://localhost:8000/openapi.json`

## Auth
- POST `/api/v1/auth/login`

Example:
```bash
curl -X POST \
-H 'Content-Type: application/json' \
-d '{"email":"[email protected]","password":"secret"}' \
http://localhost:8000/api/v1/auth/login
```

## Health
- GET `/health`

Example:
```bash
curl http://localhost:8000/health
```

## Notes
- Some endpoints require valid environment configuration (e.g., Supabase keys).
- See `DEVELOPMENT.md` for running locally.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Changelog

All notable changes to this project will be documented here.

## [Unreleased]
- Initial docs: contributing, code of conduct, changelog, API, dev workflow, deployment.
- Setup fixes: root `start.py`, Poetry entry point.
16 changes: 16 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Code of Conduct

We are committed to a welcoming, harassment-free community.

## Standards
- Be respectful and inclusive.
- Use welcoming language; accept constructive feedback.
- No harassment, hate speech, or personal attacks.

## Scope
- Applies to all project spaces and public platforms related to the project.

## Enforcement
- Report issues privately via maintainers or security advisories.
- Maintainers may take action: warnings, temporary/permanent bans.
- Decisions are final to protect community safety.
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Contributing to Devr.AI

## Quick Start
- Fork, create a branch: `git checkout -b feat/short-name`.
- Install tools: `poetry install` (backend), `npm i` in `frontend/`.
- Run locally: `poetry run start` (backend), `npm run dev` (frontend).
- Tests: `pytest` (backend), `npm run test` (frontend).
- Quality: `black`, `isort`, `flake8`, `mypy`, `eslint`, `prettier`.
- Commit small, clear messages (e.g., `fix:`, `feat:`, `docs:`).
- Open a PR with context and checklist; link issues.

## PR Rules
- Keep PRs focused; include tests and docs updates.
- CI must pass (tests, lint, type-check).
- Do not commit secrets.

## Code Style
- Python: type hints, `black` + `isort`, `flake8`, `mypy` clean.
- TS/JS: `eslint`, `prettier`, `tsc` clean.

## Security
- Report vulnerabilities privately via security advisory or email.
33 changes: 33 additions & 0 deletions DEPLOYMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Deployment

## Environment
- Copy `env.example` to `.env` and set real values:
- `SUPABASE_URL`, `SUPABASE_KEY`
- Any integration keys (optional)

## Docker (services)
```bash
# From repo root
cd backend
docker-compose up -d # Weaviate, FalkorDB, RabbitMQ
```

## Backend
```bash
# Local run
poetry run start # uses uvicorn main:api
```

## Frontend
```bash
cd frontend
npm run build
npm run preview # or deploy via your hosting provider
```

## Health Checks
- Backend health: `GET /health`
- OpenAPI: `http://localhost:8000/docs`

## Notes
- Ensure required databases/services are reachable from the backend.
42 changes: 42 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Development Workflow

## Prerequisites
- Python 3.10+, Poetry
- Node.js LTS, pnpm/npm
- Docker (optional: Weaviate, FalkorDB, RabbitMQ)

## Setup
```bash
# Backend
poetry install
# Frontend
cd frontend && npm i
```

## Run
```bash
# Backend (from repo root)
poetry run start # or: poetry run python start.py
# Frontend
cd frontend && npm run dev
```

## Tests
```bash
# Backend
pytest
# Frontend
cd frontend && npm run test
```

## Quality
```bash
# Backend
black . && isort . && flake8 && mypy
# Frontend
cd frontend && npm run format && npm run lint && npm run type-check
```

## Notes
- Configure `.env` (see `env.example`). Placeholder values may break startup.
- OpenAPI: `http://localhost:8000/docs`.
Binary file added backend/.DS_Store
Binary file not shown.