Skip to content

Setup project locally

Jump to bottom
Tanish edited this page Jan 30, 2023 · 3 revisions

Overview

This tutorial shows how to download, setup and start the ModernJava project locally on your machine.

Alternatively, you can also work directly in the cloud, for free, and get started in just a few seconds. See:

Prerequisites

  • Your favorite text editor, e.g. Vim
  • git installed (or any GUI or IDE plugin)

Tutorial

Download mdBook

Executable binaries are available for download on the GitHub Releases page. Download the binary for your platform (Windows, macOS, or Linux) and extract the archive. The archive contains an mdbook executable which you can run to build your books.

To make it easier to run, put the path to the binary into your PATH.

Go to the full guide to find other ways of downloading mdbook.

Clone repository

To download the project, use the following command:

git clone https://github.com/Together-Java/ModernJava.git

You now have the project and all its data locally.

image

Run the project

Go into the downloaded directory

cd ModernJava

Then run this command to get the book hosted on localhost

mdbook serve --open

The book should be up and running now.

image

Go to http://localhost:3000/ to access it.

Clone this wiki locally