Skip to content

Commit

Permalink
refactor: Remove liferay deploy dir
Browse files Browse the repository at this point in the history
Signed-off-by: Helio Chissini de Castro <heliocastro@gmail.com>
  • Loading branch information
heliocastro committed Jul 17, 2024
1 parent 0462eec commit 612bce6
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 26 deletions.
29 changes: 14 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@

A software component catalogue application.

SW360 is a server with a REST interface and a Liferay CE portal application
to maintain your projects / products and the software components within.
SW360 is a Backend server with a REST API to maintain your projects / products and the software components within.

It can manage SPDX files for maintaining the license conditions and maintain
license information.
Expand All @@ -18,7 +17,6 @@ license information.

It is comprised of one frontend (portal) part, backend (services) part and additionally a REST API:

* Frontend: Liferay-CE-(Tomcat-)based portal application using portlets.
* Backend: Tomcat-based thrift services for being called by different applications.
* Database: we store software components and metadata about them in CouchDB.
* Rest: this REST API provides access to project resources for external integration.
Expand All @@ -29,26 +27,24 @@ The reference platform is the Ubuntu server 22.04 (which is an LTS version).

This is a multi module maven file. please consider that we have the following modules:

* frontend: For portlets, themes and layouts, the liferay part.
* backend: For the thrift based services.
* libraries: For general stuff that is reused among the above, for example, couchdb access.
* scripts: Auxiliary scripts to help build, deploy and config system
* rest: For the REST API which contains an authorization and resource server.

### Issues

If you run in any issues with documentation or software, please be kind and report to our
If you run in any issues with documentation or software, please be kind and report to our
[Github issues area](https://github.com/eclipse/sw360/issues).

### Deployment

Is recommended using the docker based setup,
Is recommended using the docker based setup,
[described here](https://github.com/eclipse/sw360/blob/main/README_DOCKER.md).

If you intend to install in a bare metal machine or use in your own virtualizaed system, [bare metal instructions are provided here](https://www.eclipse.org/sw360/docs/deployment/baremetal/deploy-natively/).


### Development
### Development

If you intend to develop over SW360, few steps are needed as equal you need have base
requirements
Expand All @@ -58,20 +54,23 @@ requirements
* Maven 3.8.7
* pre-commit
* thrift 0.16.0 runtime
* Python environment ( to [pre-commit](https://pre-commit.com/) ) - SW360 use Eclipse formatting rules
* Python environment ( to [pre-commit](https://pre-commit.com/) ) - SW360 use Eclipse formatting rules
through [Spotless maven plugin](https://github.com/diffplug/spotless/tree/main/plugin-maven)

If you can't install thrift 0.16 runtime, you will need the following requirements:

* C++ dev environment
* cmake
Then run the current build script:
```bash

```bash
./scripts/install-thrift.sh
```

#### Local Building

**Step 1**: Prepare source code

```bash
git clone https://github.com/eclipse/sw360.git
cd sw360
Expand All @@ -80,42 +79,42 @@ pre-commit install
```

**Step 2**: Build the code (without tests and docs)

```bash
mvn package -P deploy \
-Dhelp-docs=false \
-DskipTests \
-Djars.deploy.dir=deploy \
-Drest.deploy.dir=webapps \
-Dliferay.deploy.dir=webapps \
-Dbackend.deploy.dir=webapps
```

If you want run the the tests, we need start a local couchdb server and Docker is required:

**Step 3**:
**Step 3**:

```bash
pip install mkdocs-material
./scripts/startCouchdbForTests.sh

mvn package -P deploy \
-Djars.deploy.dir=deploy \
-Drest.deploy.dir=webapps \
-Dliferay.deploy.dir=webapps \
-Dbackend.deploy.dir=webapps
```

To check your code linting without commit:

```bash
mvn spotless:check
```

Please refer to [SW360 main documentation website](https://www.eclipse.org/sw360/docs/) for more details.


### License

SPDX-License-Identifier: EPL-2.0

This program and the accompanying materials are made
available under the terms of the Eclipse Public License 2.0
which is available at https://www.eclipse.org/legal/epl-2.0/
which is available at [https://www.eclipse.org/legal/epl-2.0/](https://www.eclipse.org/legal/epl-2.0/)
16 changes: 8 additions & 8 deletions libraries/importers/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@
-->

<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>libraries</artifactId>
<groupId>org.eclipse.sw360</groupId>
<version>18.99.1</version>
</parent>
<modelVersion>4.0.0</modelVersion>
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>libraries</artifactId>
<groupId>org.eclipse.sw360</groupId>
<version>18.99.1</version>
</parent>
<modelVersion>4.0.0</modelVersion>

<name>importers</name>
<artifactId>importers</artifactId>
Expand Down
4 changes: 2 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
<maven-resources-plugin.version>3.3.0</maven-resources-plugin.version>
<maven-source-plugin.version>3.2.1</maven-source-plugin.version>
<maven-surefire-plugin.version>3.3.0</maven-surefire-plugin.version>
<maven-war-plugin.version>3.3.2</maven-war-plugin.version>
<maven-war-plugin.version>3.4.0</maven-war-plugin.version>
<versions-maven-plugin.version>2.12.0</versions-maven-plugin.version>

<!-- JSON Libraries used in the project -->
Expand Down Expand Up @@ -369,7 +369,7 @@
<groupId>org.apache.httpcomponents.client5</groupId>
<artifactId>httpclient5</artifactId>
<version>${httpclient5.version}</version>
</dependency>
</dependency>
<dependency>
<groupId>javax.activation</groupId>
<artifactId>activation</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion scripts/docker_test_build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,6 @@ docker run -it --rm \
-P deploy \
-Dhelp-docs=true \
-Dbase.deploy.dir=. \
-Dliferay.deploy.dir="${PWD}/deploy" \
-Djars.deploy.dir="${PWD}/deploy" \
-Dbackend.deploy.dir="${PWD}/deploy/webapps" \
-Drest.deploy.dir="${PWD}/deploy/webapps"

0 comments on commit 612bce6

Please sign in to comment.