Skip to content

Commit 3efdedb

Browse files
mustafasoylumustafasoylu
authored
Merge pull request #11 from Materials-Data-Science-and-Informatics/develop
update ci and docs
2 parents 6913208 + 62a5a57 commit 3efdedb

5 files changed

Lines changed: 152 additions & 5 deletions

File tree

‎.github/workflows/build-and-deploy.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Build and Deploy to GitHub Container Registry
2+
3+
on:
4+
release:
5+
types: [ published ]
6+
push:
7+
tags:
8+
- '*'
9+
workflow_dispatch:
10+
11+
env:
12+
REGISTRY: ghcr.io
13+
IMAGE_NAME: ${{ github.repository }}
14+
15+
jobs:
16+
build-and-push:
17+
runs-on: ubuntu-latest
18+
permissions:
19+
contents: read
20+
packages: write
21+
22+
steps:
23+
- name: Checkout repository
24+
uses: actions/checkout@v4
25+
26+
- name: Set up Docker Buildx
27+
uses: docker/setup-buildx-action@v3
28+
29+
- name: Log in to the Container registry
30+
if: github.event_name != 'pull_request'
31+
uses: docker/login-action@v3
32+
with:
33+
registry: ${{ env.REGISTRY }}
34+
username: ${{ github.actor }}
35+
password: ${{ secrets.GITHUB_TOKEN }}
36+
37+
- name: Extract metadata (tags, labels)
38+
id: meta
39+
uses: docker/metadata-action@v5
40+
with:
41+
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
42+
tags: |
43+
type=ref,event=tag
44+
type=semver,pattern={{version}}
45+
type=semver,pattern={{major}}.{{minor}}
46+
type=raw,value=latest,enable={{is_default_branch}}
47+
48+
- name: Build and push Docker image
49+
uses: docker/build-push-action@v5
50+
with:
51+
context: .
52+
push: true
53+
tags: ${{ steps.meta.outputs.tags }}
54+
labels: ${{ steps.meta.outputs.labels }}

‎Dockerfile‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ RUN npm install
1313
# Copy the rest of the application files
1414
COPY . .
1515

16+
# Copy the example config.yml to the root for Vite to process
17+
COPY examples/config.yml ./config.yml
18+
1619
# Build the Vite app for production
1720
RUN npm run build
1821

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Forschungszentrum Jülich GmbH - Institute Materials Data Science and Informatics (IAS9) - Stefan Sandfeld (s.sandfeld@fz-juelich.de)
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,24 @@ in the [repository](https://github.com/Materials-Data-Science-and-Informatics/rd
7777

7878
We kindly thank all authors and contributors.
7979

80+
### Third-party Libraries
81+
82+
This project uses the following open-source libraries:
83+
84+
- **react-force-graph-3d** by Vasco Asturiano - MIT License
85+
- Repository: [react-force-graph](https://github.com/vasturiano/react-force-graph)
86+
- A React component for 3D force directed graphs using ThreeJS/WebGL
87+
88+
### Funding
89+
90+
This project was developed at the Institute for Materials Data Science and Informatics
91+
(IAS-9) of the Jülich Research Center and funded by the Helmholtz Metadata Collaboration
92+
(HMC), an incubator-platform of the Helmholtz Association within the framework of the
93+
Information and Data Science strategic initiative.
94+
8095
<div>
8196
<img style="vertical-align: middle;" alt="HMC Logo" src="https://github.com/Materials-Data-Science-and-Informatics/Logos/raw/main/HMC/HMC_Logo_M.png" width=50% height=50% />
8297
&nbsp;&nbsp;
8398
<img style="vertical-align: middle;" alt="FZJ Logo" src="https://github.com/Materials-Data-Science-and-Informatics/Logos/raw/main/FZJ/FZJ.png" width=30% height=30% />
8499
</div>
85100
<br />
86-
87-
This project was developed at the Institute for Materials Data Science and Informatics
88-
(IAS-9) of the Jülich Research Center and funded by the Helmholtz Metadata Collaboration
89-
(HMC), an incubator-platform of the Helmholtz Association within the framework of the
90-
Information and Data Science strategic initiative.

‎config.yml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# links will be created from these properties
2+
relationProperties:
3+
- "http://schema.org/affiliation"
4+
- "http://schema.org/dataPublished"
5+
- "http://schema.org/dateModified"
6+
- "http://schema.org/provider"
7+
- "http://schema.org/license"
8+
- "http://schema.org/publisher"
9+
- "http://schema.org/author"
10+
- "http://schema.org/creator"
11+
- "http://schema.org/keywords"
12+
13+
# labels will be created from these properties
14+
labelProperties:
15+
- "http://schema.org/name"
16+
- "http://schema.org/text"
17+
- "http://schema.org/comment"
18+
19+
# groups will be created from these properties
20+
groups:
21+
- name: 'Organization'
22+
types:
23+
- 'http://schema.org/Organization'
24+
properties:
25+
- 'http://schema.org/affiliation'
26+
- 'http://schema.org/provider'
27+
- 'http://schema.org/publisher'
28+
color: '#008000'
29+
- name: 'Person'
30+
types:
31+
- 'http://schema.org/Person'
32+
properties:
33+
- 'http://schema.org/author'
34+
- 'http://schema.org/creator'
35+
color: '#FF0000'
36+
- name: 'Dataset'
37+
types:
38+
- 'http://schema.org/Dataset'
39+
color: '#0000FF'
40+
- name: 'Software'
41+
types:
42+
- 'http://schema.org/SoftwareSourceCode'
43+
color: '#FFFF00'
44+
- name: 'Document'
45+
types:
46+
- 'http://schema.org/Document'
47+
color: '#FFA500'
48+
- name: 'Article'
49+
types:
50+
- 'http://schema.org/Article'
51+
color: '#4B0082'
52+
- name: 'CreativeWork'
53+
types:
54+
- 'http://schema.org/CreativeWork'
55+
color: '#8A2BE2'
56+
- name: 'Service'
57+
types:
58+
- 'http://schema.org/Service'
59+
color: '#00FFFF'

0 commit comments

Comments
 (0)