Skip to content

Commit 5b8400c

Browse files
authored
Create developer_guide.rst for Sphinx documentation
1 parent 2f78d99 commit 5b8400c

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

docs/developer_guide.rst

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
Developer Guide
2+
===============
3+
4+
Architecture
5+
------------
6+
- Django project under `server/`
7+
- Main app: `drmaatic/` with `task/` and `job/` modules
8+
- Uses Django REST Framework and drmaa-python
9+
10+
Development Setup
11+
-----------------
12+
1. Fork and clone repo
13+
2. Create a virtualenv and install:
14+
pip install -r requirements.txt -r dev-requirements.txt
15+
3. Use docker/testing for SLURM
16+
4. Run migrations and createsuperuser
17+
5. Start development server
18+
19+
Running Tests
20+
-------------
21+
Run with:
22+
python manage.py test
23+
24+
Contributing
25+
------------
26+
- Follow PEP8
27+
- Use Django/DRF best practices
28+
- Document new features
29+
- Submit PRs to `dev` branch
30+
31+
Advanced Configuration
32+
----------------------
33+
- Settings via `.env`
34+
- Customize auth providers (e.g., ORCID)
35+
- Job execution uses DRMAA (or shell scripts)

0 commit comments

Comments
 (0)