Skip to content

Commit

Permalink
docs: Fix broken docs link in README.md, minor doc changes on running…
Browse files Browse the repository at this point in the history
… locally (#830)

Fix broken docs link in README.md, minor doc changes on running locally

Co-authored-by: Hari John Kuriakose <[email protected]>
  • Loading branch information
chandrasekharan-zipstack and hari-kuriakose authored Nov 12, 2024
1 parent c7ebed4 commit b44c771
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 4 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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).
40 changes: 37 additions & 3 deletions backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit b44c771

Please sign in to comment.