|
4 | 4 |
|
5 | 5 | # ALEX |
6 | 6 |
|
7 | | -Automata Learning Experience (ALEX) is an extension of the [LearnLib](https://github.com/LearnLib/learnlib) that allows |
8 | | -you run automated tests on web applications and JSON-based REST APIs using active automata learning. |
| 7 | +[](https://travis-ci.org/LearnLib/alex) |
9 | 8 |
|
10 | | -Users model basic test inputs for their target application which are used by ALEX to automatically infer an automaton |
11 | | -model, or to be more precise, a [Mealy machine](https://en.wikipedia.org/wiki/Mealy_machine) that represents the |
12 | | -behavior of the web application. |
| 9 | +Automata Learning EXperience (ALEX) is an extension of [LearnLib][learnlib] that allows you run automated tests on web |
| 10 | +applications and JSON-based REST APIs using active automata learning. |
13 | 11 |
|
14 | | -## Installation and login |
| 12 | +Users model [Selenium][selenium]- or HTTP-based test inputs for their application, which are used to automatically infer |
| 13 | +an automaton model (a [Mealy machine][mealy]), which represents the behavior of the web application. |
15 | 14 |
|
16 | | -We developed and tested ALEX using either Windows 8.1 and higher and Linux Ubuntu 14.10 and higher. |
17 | | -As the application runs on JAVA, any other system with an installed JVM should do fine. |
18 | | -We also advise to use a modern web browser like Google Chrome, Mozilla Firefox or Microsoft Edge with JavaScript enabled. |
| 15 | +## Installation |
19 | 16 |
|
20 | | -After the first start, you can login as an admin using the account below. |
21 | | - |
22 | | -Email: *admin@alex.example* <br> |
23 | | -Password: *admin* |
| 17 | +Make sure you have Java 8 installed on your system. |
| 18 | +We advise to use a modern web browser like Google Chrome, Mozilla Firefox or Microsoft Edge with JavaScript enabled. |
24 | 19 |
|
25 | | -#### Using the packaged version |
| 20 | +1. [Download](https://github.com/LearnLib/alex/releases/latest) the latest version. |
| 21 | +2. Open a terminal and start ALEX via `java -jar alex-1.5.0.war [--alex.port=XXXX]`. |
| 22 | +3. Wait until the command line prints something like `de.learnlib.alex.App - Started App in XX.XXX seconds`. |
| 23 | +3. Open *http://localhost:8000* in a web browser. |
26 | 24 |
|
27 | | -Make sure you have Java 8 installed on your system. |
| 25 | +After the first start, you can login as an admin using the account below: |
28 | 26 |
|
29 | | -1. Download the latest version. [Download](https://github.com/LearnLib/alex/releases/latest) |
30 | | -2. Open a terminal and start the *war* archive using `java -jar ALEX.war [--port=XXXX]` |
31 | | -3. Open *http://localhost:8000* in a web browser |
| 27 | +Email: *admin@alex.example* <br> |
| 28 | +Password: *admin* |
32 | 29 |
|
33 | | -#### From source |
| 30 | +## Build instructions |
34 | 31 |
|
35 | | -For the installation from the source files make sure your system matches the following requirements: |
| 32 | +In order to build ALEX from source make sure your system matches the following requirements: |
36 | 33 |
|
37 | 34 | * Java JDK 8 |
38 | 35 | * Maven 3 |
39 | | -* Node.js v7.9.* and the NPM |
40 | | - |
41 | | -To obtain ALEX execute the following commands in a directory of your choice: |
42 | | - |
43 | | -1. `git clone https://github.com/LearnLib/alex.git` |
44 | | -2. `cd alex` |
| 36 | +* Node.js (v10.0.0) and the NPM (v6.0.0) |
45 | 37 |
|
46 | | -Afterwards you can build and run ALEX by running following commands: |
| 38 | +To build ALEX, open a terminal and follow the instructions below: |
47 | 39 |
|
48 | | -1. `mvn clean package [-DskipTests]` |
49 | | -2. `java -jar build/target/ALEX/*war [--alex.port=XXXX]` |
50 | | -3. open *http://localhost:8000* in a web browser |
| 40 | +```bash |
| 41 | +# clone the repository |
| 42 | +git clone https://github.com/LearnLib/alex.git |
51 | 43 |
|
52 | | -Or, if you just want to start the backend, you can use: |
| 44 | +# navigate to the project directory |
| 45 | +cd alex |
53 | 46 |
|
54 | | -1. `cd main` |
55 | | -2. `mvn spring-boot:run [-Dalex.port=XXXX]` |
56 | | -3. open *http://localhost:8000* in a web browser |
| 47 | +# build ALEX |
| 48 | +mvn install package [-DskipTests] |
| 49 | +``` |
57 | 50 |
|
| 51 | +The bundle can then be found at `build/target/alex-build-1.5.0.war`. |
58 | 52 |
|
59 | 53 | ## Further reading |
60 | 54 |
|
61 | | -* [User manual](http://learnlib.github.io/alex/book/1.4.0/contents/user-manual/index.html) |
62 | | -* [Examples](http://learnlib.github.io/alex/book/1.4.0/contents/examples/index.html) |
63 | | -* [Developer docs](http://learnlib.github.io/alex/book/1.4.0/contents/developer-documents/index.html) |
| 55 | +* [User manual](http://learnlib.github.io/alex/book/1.5.0/contents/user-manual/index.html) |
| 56 | +* [Examples](http://learnlib.github.io/alex/book/1.5.0/contents/examples/index.html) |
| 57 | +* [Developer docs](http://learnlib.github.io/alex/book/1.5.0/contents/developer-documents/index.html) |
64 | 58 | * [Active automata learning](https://scholar.google.de/scholar?hl=de&q=active+automata+learning) |
65 | 59 | * [LearnLib](http://learnlib.de/) |
| 60 | + |
| 61 | + |
| 62 | +[learnlib]: https://github.com/LearnLib/learnlib |
| 63 | +[mealy]: https://en.wikipedia.org/wiki/Mealy_machine |
| 64 | +[selenium]: https://www.seleniumhq.org/ |
0 commit comments