User Tools


Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
developers [2021/09/19 00:39]
62.210.143.10 old revision restored (2016/06/11 21:02)
developers [2021/10/01 00:42] (current)
65.21.180.17 old revision restored (2021/09/18 16:22)
Line 20: Line 20:
  
 # Setting Up a Development Environment # Setting Up a Development Environment
 +
 +Start by forking our repository on GitHub. Under most circumstances, you will want to fork our development repo, https://github.com/WesGilster/Creation-Workshop-Host. For immediate fixes for the stable release, you may instead fork the production stable repo https://github.com/area515/Creation-Workshop-Host.
 +
 +To fork a repo, simply visit the repo on GitHub via the above links and click on the "fork" button.
 +
 +Next, you'll need to decide whether you want to set up a development environment on the cloud or on your local PC. A cloud-based development environment is quicker to set up and can be used in a location independent way, although there are conveniences from having a full-fledged local IDE and offline access.
 +
 +## Cloud 9 IDE
 +
 +  - Visit https://c9.io and click the GitHub icon in the upper right to sign in with your GitHub account
 +  - Click on **Repositories** in the left navbar
 +  - Locate the forked repo that you created earlier and click **Clone to Edit"
 +  - Set a workspace name (must be all lower case) and select the HTML5 template
 +  - Once the repository is populated, open a terminal tab in the bottom pane and execute the following commands:
 +
 +```
 +sudo add-apt-repository ppa:webupd8team/java
 +sudo apt-get update
 +sudo apt-get install oracle-java8-set-default
 +```
 +
 +
 +## Desktop IDEs
 +
 +# Building and Running
 +
 +The project uses gradle to build, run, and test the code base. The gradle wrapper is included in the repository, so it is not necessary to install Gradle onto your system. Only a working JDK 8 environment is required.
 +
 +Gradle needs to be run at the command line (both on Windows and Linux). Open a command line prompt and change your working directory to be the `host` directory inside your repository.
 +
 + * `./gradlew assemble` - compile all of the parts of the project
 + * `./gradlew run` - assemble the project, if necessary, and then run Photonic3D on your computer
 + * `./gradlew build` - assemble the project and run unit tests
 + * `./gradlew dist` - assemble the project and create a distribution zip to install onto a Raspberry Pi
 + * `./gradlew fullRelease` - Generates a release to GitHub Releases
 +