rotini/README.md

<p align="center">
    <img src="./assets/rotini-logo.png">
</p>
<h1 align="center">Rotini</h1>

## Overview

**Rotini** is a self-hosted cloud storage application that gives you full-control over the data you store. It aims
for simplicity and extensibility, such that you can get started in minutes and easily fork or contribute upstream if you
fancy a feature that's not already there.

It's roadmap is currently TBD and will become better defined as it gets closer to a first release.

## Development

### Tooling

Utility commands are managed by [go-task](https://github.com/go-task/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

```sh
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`:

```sh
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:

```sh
task be:start -- <options>
```

See the README files of each of those environments ([backend](./backend/README.md), [frontend](./frontend/README.md)) for specific requirements.)
chore: add logo to README (#20) 2023-08-16 17:49:24 +00:00			`<p align="center">`
			`<img src="./assets/rotini-logo.png">`
			`</p>`
			`<h1 align="center">Rotini</h1>`

			`## Overview`

			`Rotini is a self-hosted cloud storage application that gives you full-control over the data you store. It aims`
			`for simplicity and extensibility, such that you can get started in minutes and easily fork or contribute upstream if you`
			`fancy a feature that's not already there.`

			`It's roadmap is currently TBD and will become better defined as it gets closer to a first release.`
feat(backend): sub fetch endpoints (#2) * feat(backend): sub fetch endpoints * ci: skip frontend/backend if no frontend change * ci: backend formatting * build: tooling and commands * build: psycopg2 * build: dependency locking tooling * build: pylint * feat: migration handling * feat: rudimentary upload flow * feat: basic file create/read interactions * docs: stubs * build: migration command 2023-08-09 03:49:54 +00:00
			`## Development`

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 20:32:07 +00:00			`### Tooling`

			Utility commands are managed by [go-task](https://github.com/go-task/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`.

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-16 03:57:09 +00:00			`#### Starting the backend application`

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

			```sh
			`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`:

			```sh
			`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:

			```sh
			`task be:start -- <options>`
			```

chore: add logo to README (#20) 2023-08-16 17:49:24 +00:00			`See the README files of each of those environments ([backend](./backend/README.md), [frontend](./frontend/README.md)) for specific requirements.)`