Skip to content

Commit 0826b02

Browse files
ref
1 parent a7f6d45 commit 0826b02

File tree

2 files changed

+13
-26
lines changed

2 files changed

+13
-26
lines changed

docs/projects.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ Each project defines its own label system, goals, and data scope.
55

66
<!-- <img src="/docs/assets/" alt="project_main"> -->
77

8-
---
9-
108
## 🔹 What is a Project?
119

1210
A project groups:
@@ -16,8 +14,6 @@ A project groups:
1614
- [Collection goals (per label)](/docs/goals.md)
1715
- [Assigned users with roles](/docs/users.md)
1816

19-
---
20-
2117
## 📤 Creating a Project
2218

2319
Only admin/superusers can create new projects via the UI or API.
@@ -53,8 +49,6 @@ Each project has the following sections:
5349

5450
More of that below
5551

56-
---
57-
5852
## 👥 Roles & Access
5953

6054
Users are split by admin/ non admin ones.
@@ -66,8 +60,6 @@ so you need to manually edit the permissions for it if needed.
6660

6761
See [Users & Roles](/docs/users.md) for how to manage users and set permissions
6862

69-
---
70-
7163
## 🖼️ Uploading
7264

7365
After creating you can upload images or videos.
@@ -78,8 +70,6 @@ Note: media processing on the server side may cause a slight delay before visibi
7870

7971
See [Uploads](/docs/uploads.md) for how to upload media
8072

81-
---
82-
8373
## 📝 Validation
8474

8575
When you are done with uploading you can validate this data whether it's applicable to your project or not.
@@ -89,8 +79,6 @@ Labels could be corrected there too.
8979

9080
See [Validation](/docs/validation.md) for how to validate/ see uploaded images
9181

92-
---
93-
9482
## 🧩 Label Schema
9583

9684
Each project might have a label schema, defining what’s being collected. Labels can be:
@@ -104,8 +92,6 @@ Each project might have a label schema, defining what’s being collected. Label
10492

10593
See [Labels](/docs/labels.md) for how to create and assign them.
10694

107-
---
108-
10995
## 🎯 Goals
11096

11197
Optionally, you can define target counts for labels (e.g. "Need 100 images of `Dog`").
@@ -114,8 +100,6 @@ Optionally, you can define target counts for labels (e.g. "Need 100 images of `D
114100

115101
See [Goals](/docs/goals.md) for how to create and track them.
116102

117-
---
118-
119103
## 📊 Stats & Progress
120104

121105
Each project has a brief dashboard shows the collected count grouped by:
@@ -127,8 +111,6 @@ Each project has a brief dashboard shows the collected count grouped by:
127111

128112
See [Statistics](/docs/statistics.md)
129113

130-
---
131-
132114
## 🗃 Downloading Results
133115

134116
You can export annotated datasets as `.zip` archives with optional filters
@@ -137,8 +119,6 @@ You can export annotated datasets as `.zip` archives with optional filters
137119

138120
See [Downloads](/docs/downloads.md) for how to request archives
139121

140-
---
141-
142122
## ⚙️ Edit project
143123

144124
You can at any time change project info, labels, permissions or delete the Project.

docs/quickstart.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,28 @@ This guide walks you through setting up and using ISS Data Collection Tool local
99
```bash
1010
git clone https://github.com/ISSResearch/Data-Collection-Tool.git
1111
cd data-collection-tool
12-
cp .env.sample .env
13-
make build
1412
```
1513

16-
Make sure make, Docker, and Docker Compose are installed.
17-
Edit the .env file to suit your environment before proceeding.
14+
## 2. Build images
15+
16+
```bash
17+
make build
18+
```
1819

19-
## 2. Start in Prod Mode
20+
## 3. Start in Prod Mode
2021

2122
```bash
23+
cp .env.sample .env
2224
make start
2325
```
2426

27+
Make sure make, Docker, and Docker Compose are installed.
28+
Edit the .env file to suit your environment before proceeding.
29+
2530
This command starts all services in production mode using Docker Compose.
2631
The project will be accessible at http://localhost:8000 (default port).
2732

28-
## 3. Create admin user
33+
## 4. Create admin user
2934
```bash
3035
make init-admin
3136
```
@@ -34,5 +39,7 @@ You must create a superuser before accessing the UI.
3439
Only admin users can currently create new projects and manage roles/permissions.
3540
More about that in [Users and Roles](/docs/users.md)
3641

42+
---
43+
3744
## ✅ Next Step
3845
[Project](/docs/projects.md)

0 commit comments

Comments
 (0)