Development now happens in https://github.com/logigator/logigator
Repository to help developing Logigator.
Issues should be created in the above mentioned repository, not in this one.
You need to have node and npm installed. We recommend installing it via nvm. Additionally you need PHP 7.2 or higher and a MariaDB or MySQL Database to use the backend.
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.1/install.sh | bash
export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
nvm install lts/*Download the contents of the repository, open the command line in that directory and install it's dependencies.
git clone git@github.com:logigator/logigator-development-distribution.git
npm install
npm run setup-dev:<https/ssh>:<win32/darwin:linux>
Copy the contents of logigator-backend/config.php.example to logigator-backend/config.php and fill in the missing information.
If you leave out the Google and Twitter Keys, Google and Twitter Login will not work. If the email accounts are not filled in it won't be possible to register at all.
Run logigator-backend/db_create.sql in your database. It will create a user 'logigator' and a database 'logigator', you can change this to whatever you configured in config.php.
To create the admin account and the predefined shares run logigator-backend/inserts.sql in yor database.
Please add the following lines to your hosts file:
C:\Windows\System32\drivers\etc\hosts or /etc/hosts
127.0.0.1 logigator-local-dev.com
127.0.0.1 editor.logigator-local-dev.com
127.0.0.1 api.logigator-local-dev.com
There are a few scripts in package.json included in this repo.
start:backend- serves the backend on port 8203start:proxy- starts a proxy-server to the Backend and all dev-serversstart:backend-and-proxy- starts backend and proxy-serverstart:home- serves logigator-home on port 8201start:shared-comps- serves logigator-shared-comps for live reloadingstart:editor:web- serves logigator-editor on port 8202start:edtior:electron- serves logigator-editor electron app
It is also possible to run the scripts directly in the repositories.
It is not required to start all projects to develop, you can run logigator-editor without logigator-home or logigator-shared-comps for example.
If the simulation-mode is not working, it is most likely due to a missing WebAssembly module.
To fix this issue you must build the Simulation Code by your self.
Instructions for doing so can be found in the simulation repo.
After you built the simulation-code, just copy the contents of logigator-simulation/webAssembly/dist/ to logigator-editor/src/assets/wasm.
Firstly you have to create a fork of the repository you want to contribute to. So for example if you want to contribute to logigator-editor you have to fork https://github.com/logigator/logigator-editor.git.
The following explanation will show you how to contribute to logigator-editor, but the process is the same for all other repositories as well.
cd logigator-editor
git rename origin upstream
git remote add origin git@github.com:Liioooo/logigator-editor.git
git fetch upstream
git checkout development
git merge upstream/development
git push originNote: Everything after git checkout development is only required if there where changes in logigator, so you need to update your own fork.
After you did this you can start making changes. After you made some changes create a new branch and push it to your fork.
git checkout -b my-change
git add .
git commit -m 'Best change ever'
git pushNow you can create a pull request from your fork to the logigator organisation. If there is a development branch in the logigator repo, please select it as base instead of master.
This Project is licensed under the MIT License - see the LICENSE file for details