Skip to content

LLM-Driven Extraction of Unstructured Data — Built for API Deployments & ETL Pipeline Workflows

docs: Fix broken docs link in README.md, minor doc changes on running locally (#830)

Chandrasekharan Mb44c7716c253
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a33e14be8..5ddf6f648 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,3 +1,3 @@
# Contributing
-See [docs.unstract.com](https://docs.unstract.com/contributing/unstract).
+See [docs.unstract.com](https://docs.unstract.com/unstract/contributing/unstract).
diff --git a/backend/README.md b/backend/README.md
index 4cb24a646..a048efec8 100644
--- a/backend/README.md
+++ b/backend/README.md
@@ -8,11 +8,45 @@ Contains the backend services for Unstract written with Django and DRF.
1. Redis
## Getting started
-**NOTE**: All commands are executed from `/backend` and require the venv to be active. Refer [these steps](/README.md#create-your-virtual-env) to create/activate your venv
-### Install and run manually
+### Install and run locally
-- Ensure that you've sourced your virtual environment and installed dependencies mentioned [here](/README.md#create-your-virtual-env).
+#### Create your virtual env
+
+All commands assumes that you have activated your `venv`.
+
+```bash
+# Create venv
+pdm venv create -w virtualenv --with-pip
+eval "$(pdm venv activate in-project)"
+
+# Remove venv
+pdm venv remove in-project
+```
+
+#### Installing dependencies
+
+Go to service dir and install dependencies listed in corresponding `pyproject.toml`.
+
+```bash
+# Install dependencies
+pdm install
+
+# Install specific dev dependency group
+pdm install --dev -G lint
+
+# Install production dependencies only
+pdm install --prod --no-editable
+```
+
+PDM allows you to run scripts applicable within the service dir.
+
+```bash
+# List the possible scripts that can be executed
+pdm run -l
+```
+
+#### Running commands
- If you plan to run the django server locally, make sure the dependent services are up (either locally or through docker compose)
- Copy `sample.env` into `.env` and update the necessary variables. For eg: