TODO: DOCUMENTATION
To get the app up and running on your machine:
cd deploy
./cmds/init-local-dev.sh
./cmds/build-local-dev.sh
./cmds/generate-deployment-files.sh
ucdlib-travel-local-dev
will have been created.docker compose up
To start the JS/SCSS watch process run cd src/client && npm run watch
deploy:
desc: Scripts for building/deploying app on your local machine and/or a server
items:
- cmds: Deploy/devops scripts
- db-entrypoint: SQL files that run on container start if db is empty
- templates: Handlebar-style templates of deployment files
- utils: Deployment utilities, such as data init and backup
src:
desc: Application source code
items:
- api:
desc: Server-side source code. JSON data endpoints to be consumed by cork-app-utils services.
- client:
desc: Browser-side source code
items:
- build: Config files for webpack assets build
- public: Static asset directory. Everything here will be served. index.html is where the SPA code will be loaded
- scss: SCSS source code. By default, loads ucdlib theme.
- js: JS source code - Lit pages and components.
- lib:
desc: Code imported and used by the browser or server endpoints
items:
- cork: cork-app-utils models, services, and stores.
- db-models: Models for interacting with database. In general, each model will correspond with a table.
- utils: Any shared code.
- index.js: Entry point for application.
This project comes with optional utilities that:
To set these up, you will need to:
GC_BACKUP_BUCKET
variable in config.sh. This is required for both the init and backup utilities.GC_READER_KEY_SECRET
variable in config.sh. This is required for the init utility.GC_WRITER_KEY_SECRET
variable in config.sh. This is required for the backup utility.