Merge pull request #289 from com-pas/282-adhere-to-monorepository-str…

…ucture

infra!: adhere to monorepo strucutre of open-scd

.github/dependabot.yml

@@ -12,7 +12,7 @@ updates:
       interval: "daily"
     open-pull-requests-limit: 5
   - package-ecosystem: "docker"
-    directory: "/"
+    directory: "packages/compas-openscd/"
     schedule:
       interval: "daily"
     open-pull-requests-limit: 5

.github/workflows/build-project.yml

@@ -42,19 +42,21 @@ jobs:
         timeout-minutes: 45
         if: ${{ github.event_name == 'push' }}
         run: |
+          cd packages/compas-open-scd
           npm ci
           npm run-script test
 
       - name: Build application with npm
         if: ${{ github.event_name == 'pull_request' }}
         timeout-minutes: 45
         run: |
+          cd packages/compas-open-scd
           npm ci
           npm run-script build
       - name: Build docker image
         if: ${{ github.event_name == 'pull_request' }}
         uses: docker/build-push-action@v5
         with:
-          # Set the context to use the current directory and not execute it's own git checkout.
-          context: .
+          # Set the context to use the packages/compas-open-scd directory and not execute it's own git checkout.
+          context: packages/compas-open-scd
           push: false

.github/workflows/release-project.yml

@@ -44,13 +44,14 @@ jobs:
 
       - name: Build application with npm
         run: |
+          cd packages/compas-open-scd
           npm ci
           npm run-script build
       - name: Build and push docker image to Docker Hub
         uses: docker/build-push-action@v5
         with:
-          # Set the context to use the current directory and not execute it's own git checkout.
-          context: .
+          # Set the context to use the packages/compas-open-scd directory and not execute it's own git checkout.
+          context: packages/compas-open-scd
           push: true
           # Tag the images using the tagname and also latest.
           tags: |

.github/workflows/test-and-build.yml

@@ -15,5 +15,6 @@ jobs:
 
       - name: Install and Build
         run: |
+          cd packages/compas-open-scd
           npm ci
           npm run-script build

.github/workflows/test.yml

@@ -18,5 +18,6 @@ jobs:
 
       - name: Install and Test
         run: |
+          cd packages/compas-open-scd
           npm ci
           npm run-script test

.gitignore

@@ -6,20 +6,5 @@
 .DS_Store
 
 ## npm
-/node_modules/
+node_modules/
 /npm-debug.log
-
-## testing
-/coverage/
-/**/dist/*.snap.dev.js
-
-## docs
-/doc/
-
-# build
-/_site/
-/build/
-/out-tsc/
-
-/public/cim/
-!/public/cim/README.md

README.md

@@ -17,21 +17,23 @@ CoMPAS Open Substation Communication Designer is an editor for SCL files as desc
 CoMPAS OpenSCD is a fork of the [OpenSCD](https://github.com/openscd/open-scd) project. The idea is to add functionality
 to use the CoMPAS Backend Service to open and save SCL Files and more.
 
-## Contributing
+## Development
 
-See [Development](DEVELOPMENT.md) for more information about how to build and run CoMPAS OpenSCD locally.
+This repository is a [↗ monorepo](https://en.wikipedia.org/wiki/Monorepo), made up of several packages.
+To find out more about the development of each packages, such as the base distribution or the plugins, please refer to their respective READMEs:
+- [open-scd](packages/open-scd/README.md): provides the (upstream) base distribution available on [openscd.github.io](https://openscd.github.io)
+- [compas-open-scd](packages/compas-open-scd/README.md): provides the base distribution available on [demo.compas.energy](https://demo.compas.energy)
 
-## Releasing
+## Contributing
 
-See [Releasing](RELEASING.md) for a step by step guide on releasing this fork with the latest version of [open-scd](https://github.com/openscd/open-scd/).
+A recommended read for every newcomer to the CoMPAS project is [the CoMPAS Contributing guide](https://com-pas.github.io/contributing/).
 
-## License
+You can also get in touch by joining the `#compas` channel hosted on [the LF Energy Slack server](https://lfenergy.slack.com/archives/C01926K9D39). 
 
-The [IEC 61850](https://webstore.iec.ch/publication/63319) XSD and NSD code components used are
-distributed under their [end user license agreement](CC-EULA.pdf).
+## Documentation
 
-This project is licensed under the [Apache License 2.0](LICENSE.md).
+How the documentation is organized.
 
-© 2020-2022 OMICRON electronics GmbH, TransnetBW GmbH, Alliander N.V., and others
+A high-level overview of how it’s organized will help you know where to look for certain things:
 
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenscd%2Fopen-scd.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenscd%2Fopen-scd?ref=badge_large)
+- [⚖️ Decisions](docs/decisions/README.md) documents the decisions we made and why we made them.