Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update README #155

Closed
wants to merge 19 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
10869fa
refactor: apply the ESlint rules for ( react and typescript ) from ch…
hamed-musallam Aug 30, 2023
cd7688b
chore: trigger dev-check workflow only on PR to the development branch
hamed-musallam Aug 30, 2023
98837a4
Merge pull request #140 from NFDI4Chem/refactor-dev-check-workflow
NishaSharma14 Aug 30, 2023
113566a
Merge pull request #139 from NFDI4Chem/refactor-eslint-rules
NishaSharma14 Aug 30, 2023
c8252b3
chore(workflow): update Node CI workflow
hamed-musallam Sep 2, 2023
57e9934
feat: about 'NMRium wrapper' modal
hamed-musallam Sep 1, 2023
74c4938
chore: update dependencies
hamed-musallam Sep 2, 2023
9bd404c
chore: update Eslint ignored files
hamed-musallam Sep 2, 2023
cd4952d
chore: update .gitignore file
hamed-musallam Sep 2, 2023
732f5db
chore(workflow): update version info with the latest commit during de…
hamed-musallam Sep 2, 2023
8dd0eb9
chore(workflow): update checkout action to version 3
hamed-musallam Sep 2, 2023
1764046
feat: auto processing 1d proton and carbon
hamed-musallam Sep 5, 2023
8f49795
Merge pull request #145 from NFDI4Chem/auto-processing-1d-proton-carbon
CS76 Sep 5, 2023
052b225
refactor: update the GitHub link for the project in the information s…
hamed-musallam Sep 8, 2023
a62528a
Merge pull request #152 from NFDI4Chem/refactor-about-wrapper-modal
NishaSharma14 Sep 11, 2023
a8bf58f
build: push docker image to Docker Hub
NishaSharma14 Sep 11, 2023
beed7fd
Merge pull request #153 from NFDI4Chem/dev-nisha
NishaSharma14 Sep 11, 2023
3a56ab8
build: docker login
NishaSharma14 Sep 11, 2023
cba3e66
docs: update README
NishaSharma14 Sep 12, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
dist
node_modules
public
public
build
src/*.json
vite.config.*
lib
93 changes: 0 additions & 93 deletions .eslintrc.json

This file was deleted.

22 changes: 22 additions & 0 deletions .eslintrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
root: true
extends:
- cheminfo-react/base
- cheminfo-typescript/base
- cheminfo-typescript/unicorn
rules:
'import/default': off
'import/no-unresolved': off
'react-refresh/only-export-components': off
'@typescript-eslint/naming-convention': off
'@typescript-eslint/restrict-plus-operands': off
'react/no-unstable-nested-components': off
no-restricted-imports:
- error
- name: '@simbathesailor/use-what-changed'
message: 'Remove use-what-changed before committing the code'
react/no-unknown-property:
- error
- ignore:
- 'css'
parserOptions:
sourceType: module
42 changes: 26 additions & 16 deletions .github/workflows/dev-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,10 @@ env:
GKE_CLUSTER_DEV: nmrxiv-dev
GKE_ZONE: europe-west3-a
DEPLOYMENT_NAME: nmrxiv-nmrium
REPOSITORY_NAME_DEV: nmrxiv-dev
IMAGE: nmrium
DOCKER_HUB_USERNAME : ${{ secrets.DOCKER_HUB_USERNAME }}
DOCKER_HUB_PASSWORD : ${{ secrets.DOCKER_HUB_PASSWORD }}
REPOSITORY_NAME: nmrium-react-wrapper
REPOSITORY_NAMESPACE: nfdi4chem

jobs:
e2etest:
Expand All @@ -37,7 +39,12 @@ jobs:
needs: [lint, e2etest]
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v3

- name: Update version number
run: |
VERSION=${GITHUB_REF//*\/}
echo "export default { version: '$VERSION' };" > src/versionInfo.ts

# Setup gcloud CLI
- name: Setup CLI
Expand All @@ -46,11 +53,6 @@ jobs:
service_account_key: ${{ secrets.GKE_SA_KEY }}
project_id: ${{ secrets.GKE_PROJECT }}

# Configure docker to use the gcloud command-line tool as a credential helper
- name: Configure docker
run: |-
gcloud auth configure-docker europe-west3-docker.pkg.dev

# Get the GKE credentials so we can deploy to the cluster
- name: Get GKE credentials
uses: google-github-actions/[email protected]
Expand All @@ -59,15 +61,23 @@ jobs:
location: ${{ env.GKE_ZONE }}
credentials: ${{ secrets.GKE_SA_KEY }}

# Build the Docker image
- name: Build docker image
run: |-
docker build -f Dockerfile.prod --tag europe-west3-docker.pkg.dev/$PROJECT_ID/$REPOSITORY_NAME_DEV/$IMAGE:latest .
- name: Log in to Docker Hub
uses: docker/login-action@f4ef78c080cd8ba55a85445d5b36e214a81df20a
with:
username: ${{ env.DOCKER_HUB_USERNAME }}
password: ${{ env.DOCKER_HUB_PASSWORD }}

# Push the Docker image to Google Artifact Registry
- name: Publish image to Google Artifact Registry
run: |-
docker push "europe-west3-docker.pkg.dev/$PROJECT_ID/$REPOSITORY_NAME_DEV/$IMAGE:latest"
- name: Build and push Docker image
uses: docker/build-push-action@v4
with:
context: .
file: ./Dockerfile.prod
push: true
build-args: |
RELEASE_VERSION=dev-latest
tags: ${{ env.REPOSITORY_NAMESPACE }}/${{ env.REPOSITORY_NAME }}:dev-latest
username: ${{ env.DOCKER_HUB_USERNAME }}
password: ${{ env.DOCKER_HUB_PASSWORD }}

# Deploy the latest Docker image to the GKE cluster
- name: Deploy
Expand Down
4 changes: 0 additions & 4 deletions .github/workflows/dev-check.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
name: Node.js Dev Checking

on:
push:
branches-ignore:
- 'main'
- 'development'
pull_request:
branches:
- development
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/nodejs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ jobs:
nodejs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 16.x
node-version: 18.x
- name: Install dependencies
run: npm ci
- name: Run ESLint
Expand Down
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,11 @@ npm-debug.log*
yarn-debug.log*
yarn-error.log*
yarn.lock


.eslintcache

.vscode

/test-results
/playwright-report
1 change: 1 addition & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,16 @@ To further enable integration in other applications developed with modern framew

[https://nmrium.nmrxiv.org/releases/v0.1.0](https://nmrium.nmrxiv.org/releases/v0.1.0) -> [v0.1.0](https://github.com/NFDI4Chem/nmrium-react-wrapper/releases/tag/v0.1.0)

## Docker Hub
Containerized using Docker and is distributed publicly via the [Docker Hub](https://hub.docker.com/r/nfdi4chem/nmrium-react-wrapper).

Link to Docker Hub - https://hub.docker.com/r/nfdi4chem/nmrium-react-wrapper

## Kubernetes and Helm Charts
NMRium React Wrapper comes packaged with a [Helm chart](https://helm.sh/docs/), that makes it easy to deploy and manage (scale) containers on [Kubernetes](https://kubernetes.io/docs/home/) via a convenient package manager interface.

Link to Helm Chart repo - https://github.com/NFDI4Chem/repo-helm-charts/tree/main/charts/nmrium

### Embed

```
Expand Down
Loading