This repository has been archived on 2024-07-19. You can view files and clone it, but cannot push or open issues or pull requests.
rotini/README.md
Marc Cataford fbba07cbdc
build: tooling clean-up (#14)
* build(backend): requirements-locks to use venv directly to avoid needing to activate

* build(backend): taskfile cleaning, no more sourcing

* build(frontend): remove unneeded syntax, cmds>cmd for one-liners

* docs: instructors on local setup

* ci: hoisted default working directory settings
2023-08-12 16:32:07 -04:00

893 B

rotini

An unnamed cloud storage app

Development

Tooling

Utility commands are managed by go-task and can be called from anywhere. Running . script/bootstrap installs go-task within the project and gets everything ready. From there, task -l provides a breakdown of available tools.

Note that this is the preferred way to running any tooling-related task within the repository, regardless of environment.

Running locally

The application requires a Postgres database instance to be made available to the backend. This can be done for you via task be:start-db.

Starting the backend and frontend applications can be done via task be:start and task fe:start.

See the README files of each of those environments (backend, frontend) for specific requirements (i.e. environment dotfiles).