Skip to content

Add developer documentation for components #36

@absoludity

Description

@absoludity

I've been taking a look at the project to learn (and prepare a few things) and although the README contains info about running the app in development (via docker compose etc.), I can't find any instructions for developing on different components.

For example, if I look at the api directory, I see it has its own requirements.txt file, which on inspecting, looks like run-time requirements only. Does this mean that I should create a virtualenv and install those as well as the parent directories requirements-dev.txt?

I look at the Makefile and see I can run make test, but that fails due to the venv not being setup (which isn't mentioned, nor does the Makefile have a target to set one up, which could be a dep of the test target):

(api-learning) ~/dev/gosource/stuf$ make test
Running fast tests (unit + integration)...
/bin/sh: 1: python: not found
make: *** [Makefile:69: test] Error 127

I'll fix the latter part and update the README.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions