Skip to content

Commit b33643d

Browse files
committed
improves documentation (WIP)
1 parent 5d94a9b commit b33643d

1 file changed

Lines changed: 39 additions & 0 deletions

File tree

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33

44
# Arcade Analytics - Play With Data
55

6+
Docker images of Arcade and demo databases are available on [Docker hub](https://cloud.docker.com/u/arcadeanalytics/)
7+
8+
## Quick start
9+
610
To launch ArcadeAnalytics just run (needs docker installed)
711

812
docker-compose -f src/main/docker/app.yml up
@@ -13,12 +17,47 @@ and then go to
1317

1418
login as _user_ with password _user_
1519

20+
To be able to create new users, fill the properties inside the compose:
21+
22+
- SPRING_EMAIL_HOST=smtp.gmail.com
23+
- SPRING_EMAIL_PORT=587
24+
- SPRING_EMAIL_USERNAME=
25+
- SPRING_EMAIL_PASSWORD=
26+
- JHNIPSTER_MAIL_FROM=
27+
- JHNIPSTER_MAIL_BASE-URL=
28+
29+
Then restart the container and login with admin/admin credentials.
30+
1631
The Docker compose starts ArcadeAnalytics, a PostgreSQL database, an Elastic instance and an OrientDB with its _demodb_ preloaded.
1732

1833
For detailed instructions on how to use Arcade read the [manual](https://arcadeanalytics.com/usermanual/)
1934

35+
## Start with "single" (embedded) image
36+
37+
Arcade is provided as a all-embedded image, where hsql and embedded Elasicsearch are used instead of Postgresql and ES on separate containers.
38+
39+
docker-compose -f src/main/docker/app-single.yml up
40+
41+
This compose doesn't start containers with test databases
42+
43+
## Run support containers with test databases
44+
45+
Compose configurations with preconfigured databases are provided in the src/main/docker directory:
46+
* OrientDB with preconfigured demodb
47+
* Postgres with dvd rental demo database
48+
* Mysql with sakila (dvd rental) demo database
49+
50+
To run a db container use the provided compose:
51+
52+
docker-compose -f src/main/docker/postgresql-dvd-rental.yml up
53+
54+
docker-compose -f src/main/docker/orientdb2.yml up
55+
56+
2057
## Development
2158

59+
*NOTE*: Arcade was built using JHipster
60+
2261
Before you can build this project, you must install and configure the following dependencies on your machine:
2362

2463
1. [Node.js][]: We use Node to run a development web server and build the project.

0 commit comments

Comments
 (0)