https://github.com/yugabytedb-samples/yugabytedb-vaadin-crm
Simple CRM system using Vaadin as the web framework and YugabyteDB as the database.
https://github.com/yugabytedb-samples/yugabytedb-vaadin-crm
distributed-database vaadin yugabytedb
Last synced: 2 months ago
JSON representation
Simple CRM system using Vaadin as the web framework and YugabyteDB as the database.
- Host: GitHub
- URL: https://github.com/yugabytedb-samples/yugabytedb-vaadin-crm
- Owner: YugabyteDB-Samples
- License: unlicense
- Created: 2022-07-06T19:16:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-06T20:15:49.000Z (over 3 years ago)
- Last Synced: 2025-01-20T17:18:16.618Z (9 months ago)
- Topics: distributed-database, vaadin, yugabytedb
- Language: Java
- Homepage:
- Size: 396 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Simple CRM With Vaadin and YugabyteDB
This is a simple customer relationships management (CRM) application that uses Vaadin as a web framework and YugabyteDB (or PostgreSQL) as a database. The app was created from the following [Vaadin tutorial](https://vaadin.com/docs/latest/tutorial) and modified to support YugabyteDB.
- [Simple CRM With Vaadin and YugabyteDB](#simple-crm-with-vaadin-and-yugabytedb)
- [Starting Database](#starting-database)
- [YugabyteDB Managed](#yugabytedb-managed)
- [YugabyteDB Local Cluster](#yugabytedb-local-cluster)
- [PostgreSQL](#postgresql)
- [Running Application](#running-application)
- [Project Structure](#project-structure)
## Starting Database
The application works with PostgreSQL and YugabyteDB. Use any of the options below to provision a database instance.
### YugabyteDB Managed
1. Create a [YugabyteDB Managed](https://docs.yugabyte.com/preview/quick-start-yugabytedb-managed/) cluster.
2. Provide connectivity settings in the `yugabytedb-vaadin-crm/src/main/resources/application.properties` file. The connection string might look as follows:
```yaml
spring.datasource.url=jdbc:postgresql://us-west-2.290e0df9-a6d2-4508-bde9-3370d1669d72.aws.ybdb.io:5433/yugabyte?ssl=true&sslmode=verify-full&sslrootcert=
spring.datasource.username=
spring.datasource.password=
```
### YugabyteDB Local Cluster
1. Start a 3-node cluster with Docker:
```shell
rm -r ~/yb_docker_data
mkdir ~/yb_docker_data
docker network create yugabytedb_network
docker run -d --name yugabytedb_node1 --net yugabytedb_network \
-p 7001:7000 -p 9000:9000 -p 5433:5433 \
-v ~/yb_docker_data/node1:/home/yugabyte/yb_data --restart unless-stopped \
yugabytedb/yugabyte:latest \
bin/yugabyted start --listen=yugabytedb_node1 \
--base_dir=/home/yugabyte/yb_data --daemon=false
docker run -d --name yugabytedb_node2 --net yugabytedb_network \
-v ~/yb_docker_data/node2:/home/yugabyte/yb_data --restart unless-stopped \
yugabytedb/yugabyte:latest \
bin/yugabyted start --join=yugabytedb_node1 --listen=yugabytedb_node2 \
--base_dir=/home/yugabyte/yb_data --daemon=false
docker run -d --name yugabytedb_node3 --net yugabytedb_network \
-v ~/yb_docker_data/node3:/home/yugabyte/yb_data --restart unless-stopped \
yugabytedb/yugabyte:latest \
bin/yugabyted start --join=yugabytedb_node1 --listen=yugabytedb_node3 \
--base_dir=/home/yugabyte/yb_data --daemon=false
```
2. Make sure all 3 nodes are running: [http://127.0.0.1:7001](http://127.0.0.1:7001)
3. Provide connection parameters in the `yugabytedb-vaadin-crm/src/main/resources/application.properties` file:
```yaml
spring.datasource.url=jdbc:postgresql://127.0.0.1:5433/yugabyte
spring.datasource.username=yugabyte
spring.datasource.password=yugabyte
```
### PostgreSQL
1. Start a PostgreSQL instance in Docker:
```shell
docker run --name postgresql -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=password \
-p 5432:5432 -v ~/postgresql_data/:/var/lib/postgresql/data -d postgres
```
2. Provide connection parameters in the `yugabytedb-vaadin-crm/src/main/resources/application.properties` file:
```yaml
spring.datasource.url=jdbc:postgresql://127.0.0.1:5432/postgres
spring.datasource.username=postgres
spring.datasource.password=password
```
## Running Application
The project is a standard Maven project. To run it from the command line:
1. Try to build it (making sure you dev environment is fully set):
```shell
mvn clean package
```
2. Start the app:
```shell
mvn spring-boot:run
```
3. Open http://localhost:8080 in your browser (unless it's opened automatically).
4. Log in using the following credentials:
* username = `user`
* password = `password`
You can also import the project to your IDE of choice as you would with any
Maven project. Read more on [how to import Vaadin projects to different
IDEs](https://vaadin.com/docs/latest/flow/guide/step-by-step/importing) (Eclipse, IntelliJ IDEA, NetBeans, and VS Code).
## Project Structure
- `MainLayout.java` in `src/main/java` contains the navigation setup (i.e., the
side/top bar and the main menu). This setup uses
[App Layout](https://vaadin.com/components/vaadin-app-layout).
- `views` package in `src/main/java` contains the server-side Java views of your application.
- `views` folder in `frontend/` contains the client-side JavaScript views of your application.
- `themes` folder in `frontend/` contains the custom CSS styles.