marc/rotini
Archived
1
0
Fork 0
Code Issues 4 Pull requests 10 Projects Releases Packages Wiki Activity
An unnamed cloud storage app
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.
19 commits 11 branches 0 tags 1.3 MiB
TypeScript 55.1%
Python 40.5%
Shell 3.3%
JavaScript 0.5%
Dockerfile 0.3%
Other 0.3%
Find a file
Marc Cataford 1554e23e7f
build(backend): run as a container (#17) 
* docs: document running as a container

* build: functional dockerfile

* build: task command tweaks to accommodate docker app

* ci(backend): optionally build dev docker image
2023-08-15 23:57:09 -04:00
.github/workflows build(backend): run as a container (#17) 2023-08-15 23:57:09 -04:00
backend build(backend): run as a container (#17) 2023-08-15 23:57:09 -04:00
frontend feat(frontend): basic upload file + display in list flow 2023-08-11 00:48:57 -04:00
script feat(backend): sub fetch endpoints (#2) 2023-08-08 23:49:54 -04:00
.gitignore feat(backend): sub fetch endpoints (#2) 2023-08-08 23:49:54 -04:00
README.md build(backend): run as a container (#17) 2023-08-15 23:57:09 -04:00
Taskfile.backend.yml build(backend): run as a container (#17) 2023-08-15 23:57:09 -04:00
Taskfile.frontend.yml build: tooling clean-up (#14) 2023-08-12 16:32:07 -04:00
Taskfile.yml build: split taskfiles into be+fe concerns 2023-08-11 00:48:57 -04:00

README.md

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.

Starting the backend application

The backend application is available as a container, which you can run as

task be:start

If you opt to run your database in an adjacent container, you can either run containers in such a manner than they share a network or define the database's host via docker.host.internal:

task be:start -- --add-host docker.host.internal:host-gateway

More generally, extra options can be passed to the docker run call that runs the application this way:

task be:start -- <options>

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