README.md 1.99 KB
Newer Older
Christopher Guindon's avatar
Christopher Guindon committed
1
2
# eclipsefdn-downloads-api

3
4
5
6
## Starting a development environment

Requirements:  

Zachary Sabourin's avatar
Zachary Sabourin committed
7
8
9
* Docker
* Java 11 >  
* mvn
10
* node.js + npm  
Zachary Sabourin's avatar
Zachary Sabourin committed
11
12
* make
* Running MariaDB instance
13

Zachary Sabourin's avatar
Zachary Sabourin committed
14
15
16
17
18
1. In MariaDB instance, create a new database called `eclipse` as that is what is configured out of the box. The table definitions for the database can be found under `./config/mariadb/ddl.sql`.
2. Run `make pre-setup`. This command will setup a basic .env file, using some basic variables used in Eclipse development to accelerate the generation of secret files.
3. Ensure that the `.env` file properties reflect the connection settings used for the MariaDB instance and the credentials needed to access the DB created in step 1.
4. Run `make setup` to finish the setup process for this API, generating the secret file under `./config/application/secret.properties`.
5. Run `compile-start` or `make compile-start-headless`. The first option binds the docker containers to the current terminal, and ends the processes when the terminal is closed. The second option starts the docker containers as part of the daemon and persists beyond the terminal session.
19

Zachary Sabourin's avatar
Zachary Sabourin committed
20
The application can be checked by visiting http://localhost:8090/downloads/releases/2022-03. At this address, a return should be visible that represents the 2022-03 release of the Eclipse IDE.
21

Zachary Sabourin's avatar
Zachary Sabourin committed
22
You can run your application in dev mode that enables live coding using:
23

Zachary Sabourin's avatar
Zachary Sabourin committed
24
25
26
```bash
make dev-start
```
27
28
29
30

## Updating notice

Notice file contents were authored using the output of the Scancode-toolkit, running against the local environment. Any new packages added to the project should be evaluated before they are added to the project to ensure they are compatible with the EPL-2.0 license that this API is available under. To make use of Scancode, it will need to be [installed for Docker](https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-via-docker), and its recommended that the [Scancode-Workbench](https://github.com/nexB/scancode-workbench) be used to evaluate the results.