A web frontend for Twigs

Find a file

William Brawner 3c429e2123 Update publish and package commands to use new syntax		2022-07-12 22:04:27 -06:00
.github/workflows	Fix firebase deployments	2021-11-24 16:34:17 -07:00
.vscode	delete vscode settings file	2022-07-01 18:15:10 -06:00
e2e	Move angular code to src/client	2022-07-12 21:52:20 -06:00
src	Fixes for new Ktor API	2022-07-12 22:03:56 -06:00
.editorconfig	initial commit	2018-08-27 12:04:01 -05:00
.firebaserc	Add firebase deployment workflow	2021-11-24 16:26:28 -07:00
.gitignore	Update Angular to 13	2021-11-19 17:15:22 -07:00
angular.json	Implement login and registration	2022-07-12 22:03:55 -06:00
captain-definition	Add vscode settings for code server	2020-06-30 04:06:44 +00:00
Dockerfile	Use node:lts for docker images	2021-11-17 18:00:03 -07:00
firebase.json	Add firebase deployment workflow	2021-11-24 16:26:28 -07:00
LICENSE	Update README and add LICENSE	2021-02-27 06:51:13 -07:00
ngsw-config.json	Enable offline usage	2018-08-31 17:56:09 -05:00
package-lock.json	Update publish and package commands to use new syntax	2022-07-12 22:04:27 -06:00
package.json	Implement login and registration	2022-07-12 22:03:55 -06:00
README.md	Update README and add LICENSE	2021-02-27 06:51:13 -07:00
tasks.json	Add tasks.json	2020-06-30 04:17:15 +00:00
tsconfig.base.json	Update ng2-currency-mask	2021-06-11 11:12:09 -06:00
tsconfig.json	Move angular code to src/client	2022-07-12 21:52:20 -06:00
tslint.json	Update dependencies	2020-06-30 15:13:46 +00:00

README.md

Twigs Web Client

Twigs is an open source budgeting app aimed at people who need to share a budget. This project serves as the web front end, and is powered by Angular. The main back end project can be found at wbrawner/twigs-server

Building

You'll need NodeJS and NPM, then run

npm run build

If you would like to tinker with the site and have it hot reload, then run

npm run start

The app will be available at http://localhost:4200

Self-hosting

Eventually the plan is to ship this web app within the JAR for the server, but for now you'll need to run them separately. Before you build the app, be sure to change the apiUrl value in src/environments/environment.prod.ts. Then you can run the following command to get an optimized version of the build for production deployments

npm run package

This will output the app in a folder called dist/twigs, which you can then serve directly with Apache or Nginx or any static file server.

License

Copyright (c) 2021 William Brawner

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.