Newer
Older
- By default, local instances of the site will run on http://localhost:60606.
This can be configured with the command-line argument `server.port`.
- If you don't plan to submit changes, cloning using HTTP is fine. If you do
plan to submit changes, you'll need to clone using SSH, so you should set up
[SSH keys](https://gitlab.cs.washington.edu/help/ssh/README.md) with GitLab
if you haven't already.
- Before `push`ing, please `fetch` and then `rebase` instead of `pull`ing.
This is because `pull` means `fetch` and then `merge`, which may create an
extra "merge" commit and clutter the repo history. `rebase` will never create
such an extra commit.
### Eclipse setup
1. Install the `m2e-egit` connector (if you have an older version of Eclipse,
you may need to install `m2e` and `egit` first) so that Git and Maven can
understand each other through Eclipse.
2. Install the `m2e-apt` plugin, and in Preferences > Maven > Annotation
Processing, choose "Automatically configure JDT APT" so that Eclipse's
incremental rebuilds can perform annotation-based code generation.
3. In the "Git Repositories" view, click "Clone a Repository" and clone this
repository.
4. Right click the repository in the "Git Repositories" view and click "Import
Maven projects..." in the context menu, and import "pom.xml".
5. In the "Package Explorer" view, expand "Maven Dependencies", right click
`lombok-<version>.jar` and click "Run as > Java Application" to install
the Lombok Eclipse plugin, which provides autocompletion for generated code,
and close-and-then-reopen Eclipse.
6. To run a local instance of the site. run `WikiApplication.java` (as a Java
1. Install Maven and Java 8. These packages may be called `maven` and
`openjdk-8-jre`, but this will depend on your package manager.
2. Make sure `java -version` and `mvn -version` both
say Java 8, not an earlier version. You may need to manually set `JAVA_HOME`
in `~/.mavenrc`.
3. Clone this repository with `git clone`.
4. To build, run `mvn compile`.
5. To run a local instance of the site, run `mvn exec:java`.