https://github.com/deomorxsy/vlusk-primer
[ON-HOLD] fullstack PoC monorepo for data visualization with Python/Flask and Node/Vue.js
https://github.com/deomorxsy/vlusk-primer
flask vue-js
Last synced: 3 months ago
JSON representation
[ON-HOLD] fullstack PoC monorepo for data visualization with Python/Flask and Node/Vue.js
- Host: GitHub
- URL: https://github.com/deomorxsy/vlusk-primer
- Owner: deomorxsy
- License: gpl-3.0
- Created: 2023-12-01T01:33:27.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-26T05:33:11.000Z (9 months ago)
- Last Synced: 2025-11-18T23:02:28.976Z (8 months ago)
- Topics: flask, vue-js
- Language: Python
- Homepage:
- Size: 660 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vlusk-primer
> Simple fullstack and monorepo PoC for data visualization, using Python/Flask, Node/Vue.js and Postgres, deployed as containers handling backend, frontend and database. Test it locally with docker-compose/k3s, running the individual container images or via scripts.
container images at [hub]().
Featuring:
- Backend:Python/Flask
- ~Session-Cookie Authentication: flask_login~
- PyJWT
- Frontend: Node/Vue.js
- Build tooling: [Vite](https://vitejs.dev/guide/)
- HTTP requests: [Axios](https://axios-http.com/docs/intro)
- State Management: [pinia](https://pinia.vuejs.org/introduction.html)
- Validation: [vee-validate](https://vee-validate.logaretm.com/v4/), [yup](https://github.com/jquense/yup), “@vee-validate/yup”
- Routing: [vue-router](https://router.vuejs.org/)
- Visualization: [vue-chartjs](https://vue-chartjs.org/)
- Database ORM: SQLAlchemy
- postgres for dataframe storage
- sqlite3 for session cache [?]
## Frontend
> manually running the process
Scaffolding generated with create-vite@5.1.3:
```sh
; npm create vite@5.1.3 frontend/ -- --template vue-ts
;
; npm install vee-validate@4.12.5 yup@1.3.3 vue-router@4.2.5 vue-router@4.2.5 axios@1.6.7 pinia@2.1.7
;
; npm install -D '@types/node'
;
; npm run dev
```
## Database
> run it as a standalone container so instances of postgres aren't polluted
Run the container process with the database
```sh
podman run -it -p=5432:5432 --name dbdrop -d \
-e POSTGRES_USER=admin \
-e POSTGRES_PASSWORD=Passw0rd \
-v /mnt/ssd/dataStore/containers/database/pgad-pod/pgdata:/var/lib/postgresql/data:Z \
docker.io/library/postgres:16.0
```
Connect psql to the process, create the schema and populate the database. The loop below reads all files under the database directory in alphanumeric order, so you can always tell that the reading respects precedence.
```sh
# Create schema with Raw SQL script then populate the database
#psql -U admin -d database_name -f=file.sql
for f in *.sql;
do
psql -U admin -d dbdrop -f "$f"
done
```
## Backend
> manually running the process
Make sure to set the virtualenv:
```sh
; git clone git@github.com:isi23drop/vlusk-primer.git
; python3 -m venv venv
```
Prepare the environment:
```sh
; cd ./vlusk/backend/
; source ../venv/bin/activate
; pip3 install --upgrade pip
; pip3 install -r ./requirements.txt
```
Now that all dependencies are installed, just run each process from a different terminal:
1. database migration
```sh
flask --app app init-db
```
2. PS: now in flask 3.0 the FLASK_ENV is deprecated alongside the debug mode that goes back to the framework on the CLI call, hence the flag "--debug".
```sh
cd ./app/
flask --debug run
```
# Deployments
## Podman Service and DOCKER_HOST
[compose](https://docs.docker.com/compose/) concentrates in orchestrating multiple containers in a single host. To do this with k8s, you would need kind, k3s (does not use virtualization) or similar. It was made to be compatible with other OCI runtimes, such as Podman, which was one of the first to enable rootless containers, and can be setup with compose using the Podman Service's systemd unit file for unix sockets.
The orchestration tool ```docker-compose``` supports Podman Service through the DOCKER_HOST environment variable. This makes it possible to run containers with podman but with the benefit of rootless.
Source the [script](./scripts/podman-service-compose.sh) and run it to run compose with podman:
```sh
; source ./scripts/podman-service-compose.sh
```
## Running with the podman-compose script
## Running with k8s
Kubernetes is a container orchestrator. To run this project on single host just like the Compose tool, you can use tools like kind or k3s (which don't use virtualization).