An open API service indexing awesome lists of open source software.

https://github.com/dxps/tmc_pwa_svc

TM Community ver. 2
https://github.com/dxps/tmc_pwa_svc

Last synced: 6 months ago
JSON representation

TM Community ver. 2

Awesome Lists containing this project

README

          

# TM Community - PWA edition

This is version 2 of TM Community solution, written as a Progressive Web App (PWA) using `go-app` framework.


## Usage

### Prerequisites

- [entr](https://eradman.com/entrproject/) - used for triggering the recompile and restart of the app on code changes.

- [node](https://nodejs.org/en/download/) - used for running the TailwindCSS compiler (using `npx` in `run_css.sh`).

It regenerates the `web/styles/main.css` file on detected TailwindCSS related rules.

- [migrate](https://github.com/golang-migrate/migrate) - used for running database migrations.

See [installation](https://github.com/golang-migrate/migrate/tree/master/cmd/migrate#installation) instructions for details.

### Start

1. Start the PostgreSQL server and provision the database using:
- `cd ops`
- `./run_db_server.sh`
- `./run_db_migrations.sh`
2. Start the TailwindCSS compiler using `./run_css.sh`
3. Start the app using `./run_svc.sh`

Besides the first step that starts the database server, the other steps are for running the app in "development mode" meaning that it gets restarted on code changes.

Go to http://localhost:8081 to access the Web UI.