You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: fix checklist rendering, merge dev pages (#15)
- Add pymdownx.tasklist extension so [ ] checklists render
as proper checkboxes instead of raw square brackets
- Merge building.md + contributing.md into a single
'Development Guide' (they had ~80% duplicate content)
- Update nav and cross-references
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copy file name to clipboardExpand all lines: docs/development/contributing.md
+93-14Lines changed: 93 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,20 @@
1
-
# Contributing
1
+
# Development Guide
2
2
3
-
Contributions to LayerNexus are welcome! This guide covers the development setup, code style, and contribution workflow.
3
+
This guide covers everything you need to contribute to LayerNexus — from setting up your development environment to submitting a pull request.
4
4
5
-
## Development Setup
5
+
If you just want to **run** LayerNexus, see the [Quick Start](../quick-start.md).
6
6
7
-
### Prerequisites
7
+
---
8
+
9
+
## Prerequisites
8
10
9
11
-[Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/)
10
-
- Python 3.10+ (for running linters locally)
11
-
- Git
12
+
-[Git](https://git-scm.com/)
13
+
- Python 3.10+ (optional, for running linters locally)
14
+
15
+
---
12
16
13
-
###Getting Started
17
+
## Getting Started
14
18
15
19
```bash
16
20
# Clone the repository
@@ -23,7 +27,86 @@ docker compose up -d
23
27
# The app is now running at http://localhost:8000
24
28
```
25
29
26
-
The development `docker-compose.yml` mounts the project directory as a volume, so code changes are immediately reflected. Gunicorn runs with `--reload` for automatic reloading.
30
+
The `docker-compose.yml` mounts the project directory as a volume, so code changes are immediately reflected. Gunicorn runs with `--reload` for automatic reloading.
31
+
32
+
| Service | Description | Port |
33
+
|---|---|---|
34
+
|**web**| LayerNexus (built from local source, auto-reloads on code changes) |`8000`|
35
+
|**orcaslicer**| OrcaSlicer API |`3000`|
36
+
37
+
---
38
+
39
+
## Building Docker Images
40
+
41
+
### Release Build
42
+
43
+
```bash
44
+
docker build --target release -t layernexus .
45
+
```
46
+
47
+
This builds a production-ready image with static files baked in.
48
+
49
+
### Debug Build
50
+
51
+
```bash
52
+
docker build --target debug -t layernexus:debug .
53
+
```
54
+
55
+
The debug image includes:
56
+
57
+
-`debugpy` for remote debugging on port `5678`
58
+
-`django-debug-toolbar`
59
+
- Django's development server with auto-reload
60
+
-`DEBUG=1` by default
61
+
62
+
### Build Arguments
63
+
64
+
| Argument | Description | Default |
65
+
|---|---|---|
66
+
|`APP_VERSION`| Version string baked into the image |`dev`|
67
+
68
+
---
69
+
70
+
## Debug Docker Compose
71
+
72
+
For development with remote debugging support, build with the `debug` target:
0 commit comments