Skip to content

Commit

Permalink
Port to new stack (#230)
Browse files Browse the repository at this point in the history
  Updates the tech stack and starts with clean slate
  • Loading branch information
PandoraQS authored Oct 27, 2024
1 parent ca59ef9 commit 41b052e
Show file tree
Hide file tree
Showing 327 changed files with 119,043 additions and 96,218 deletions.
86 changes: 0 additions & 86 deletions .github/workflows/release.yml

This file was deleted.

86 changes: 0 additions & 86 deletions .github/workflows/snapshots.yml

This file was deleted.

34 changes: 0 additions & 34 deletions .github/workflows/test.yml

This file was deleted.

121 changes: 63 additions & 58 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,58 +1,63 @@
# documentation
docs/_build

# Logs
logs
*.log
npm-debug.log*

# Runtime data
pids
*.pid
*.seed

# node-waf configuration
.lock-wscript

# Dependency directories
node_modules
jspm_packages

# Build folder
dist/

# Release folder
release/

# Vim auxiliary files
.*.un~
.*.swp
.*.swo
*~

bower_components/
typings/
.vscode/


.DS_Store

test-create
demo-project
test-sim
test-vdmsim
target
test-project/Models/watertankController/generated
downloader-test/installed
downloader-test/*.zip

**/R_*
**/test-project/downloads


MakeFile

pkg/

# WebStorm project files
.idea/
# documentation
docs/_build

# Logs
logs
*.log
npm-debug.log*

# Runtime data
pids
*.pid
*.seed

# node-waf configuration
.lock-wscript

# Dependency directories
node_modules
jspm_packages

# Build folder
dist/

# Release folder
release/

# Vim auxiliary files
.*.un~
.*.swp
.*.swo
*~

bower_components/
typings/
.vscode/


.DS_Store

test-create
demo-project
test-sim
test-vdmsim
target
test-project/Models/watertankController/generated
downloader-test/installed
downloader-test/*.zip

**/R_*
**/test-project/downloads

#Test results
monocart-report/
test/coverage-reports/
coverage/
test-results/

MakeFile

pkg/

# WebStorm project files
.idea/
3 changes: 0 additions & 3 deletions .gitmodules

This file was deleted.

3 changes: 3 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Contributors

The authors and contributors of the INTO-CPS Application are, in no particular
order:

Expand All @@ -17,3 +19,4 @@ Etienne Brosse
Martin Mansfield
Anders Terkelsen
Kristoffer Stampe Villadsen
Simone Micalizzi
24 changes: 15 additions & 9 deletions DEVELOPER.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,32 @@
# Development environment documentation

## Required technologies and tools

- [Node Package Manager (NPM)](https://www.npmjs.com/package/npm): a package management system used to maintain packages used by the application. NPM 3 or higher is required.
- [Node.js](https://nodejs.org/) (v14.x is required).
- [Gulp](https://gulpjs.com/docs/en/getting-started/quick-start): a build system used to build the application.
- [Electron](http://electron.atom.io/): The app is built with Electron v10.4.7.
- [Node.js](https://nodejs.org/) (v14.x is required).
- [Visual Studio Code](https://code.visualstudio.com/) is a good choice as an editor: it's cross-platform and is actually built on top of Electron. That said, everything can be used.

To manage multiple versions of **`Node.js`** &/or **`npm`**, consider using a [node version manager](https://github.com/search?q=node+version+manager+archived%3Afalse&type=repositories&ref=advsearch).

## How to build and run the application

The following are the commands to run the application. After checking out the repo:
1. To install node dependencies: `npm install`
2. To install gulp: `npm install -g gulp` (it's easiest to have it installed globally)
3. To build the UI: `gulp` or `gulp build`
4. To run it: `npm start`
5. To run tests: `npm test`
6. To build and create a developer .exe file: `gulp package`

1. To install node dependencies: `npm install`
2. To install gulp: `npm install -g gulp` (it's easiest to have it installed globally)
3. To build the UI: `gulp` or `gulp build`
4. To run it: `npm start`
5. To run tests: `npm test`
6. To build the application for the release: `npm run dist` or `npm run dist:win` for Windows only. Please note that it's required to run the `gulp` command first.

## Useful commands and properties

- `gulp watch`: it will automatically detect when you save a file and run the corresponding build task so you only have to refresh the app when developing.
- `--no-sandbox`: the property `--no-sandbox` has been inserted to `npm start` to disable sandbox mode to prevent GPU mismanagement errors, caused by Electron conflicts, during virtualization on a Linux operating system. It is necessary, however, that this property be entered while starting the built program from the terminal. For example, starting the AppImage from the terminal we would type `./NomeAppImage --no-sandbox`. This way, the application will be started without any problems.
- `npm run clean`: cleans the working envorinment from different folders, making it ready to be deployed.

## Latest builds

The master branch is built automatically on git pushes and the output, for successful builds. Please find the artifacts by clicking in the run [of the Package workflow](https://github.com/INTO-CPS-Association/into-cps-application/actions?query=workflow%3APackage).

These builds represent ongoing work. They have not been fully tested and are not guaranteed to work. Normally, you are advised to use one of the [releases](https://github.com/INTO-CPS-Association/into-cps-application/releases).
Loading

0 comments on commit 41b052e

Please sign in to comment.