https://github.com/yavin-dev/customized-app-demo
https://github.com/yavin-dev/customized-app-demo
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/yavin-dev/customized-app-demo
- Owner: yavin-dev
- License: mit
- Created: 2021-03-25T19:16:40.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-01T17:13:56.000Z (almost 5 years ago)
- Last Synced: 2025-03-16T02:48:52.505Z (about 1 year ago)
- Language: JavaScript
- Size: 2.61 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: Code_of_Conduct.md
Awesome Lists containing this project
README
Customized Yavin App Demo
Rapidly build production quality analytics applications
## Customized Yavin App Demo
This is an demo Yavin app to showcase how Yavin can be customize.
## Getting Started
- Install Java 8 or greater (more info [here](https://yavin.dev/pages/guide/02-start.html#prerequisites))
- `git clone https://github.com/yavin-dev/customized-app-demo.git`
- `cd customized-app-demo`
### Start Yavin App
- `./gradlew bootRun`
- Open [http://localhost:8080](http://localhost:8080)
### Build & Test Deployable Jar
- Build & Test:`./gradlew build`
- Build Only:`./gradlew build -x test`
- Build For Prod:`./gradlew build -Penvironment=production`
- Run Jar: `java -jar ws/build/libs/yavin-ws.jar`
### Run Tests
- Test All: `./gradlew test`
- Test UI: `./gradlew ui:test`
- Test WS: `./gradlew ws:test`
### Clean Build
- Clean All: `./gradlew clean`
- Clean UI: `./gradlew ui:clean`
- Clean WS: `./gradlew ws:clean`
### Customize
- Define your [DB config](./ws/src/main/resources/demo-configs/db/sql/DemoConnection.hjson) (currently loads data via the [create-demo-data.sql](./ws/src/main/resources/create-demo-data.sql) script)
- Define your [table config](./ws/src/main/resources/demo-configs/models/tables/DemoTables.hjson)
- Check out our [installation guide](https://yavin.dev/pages/guide/03-start.html#yavin-detailed-installation-guide) for more info
## Resources
[Yavin framework resources](https://github.com/yavin-dev/framework#resources)
More documentation can be found on [yavin.dev](https://yavin.dev)
## License
This project is licensed under the [MIT License](LICENSE.md).