Skip to content

Latest commit

 

History

History
executable file
·
104 lines (65 loc) · 2.73 KB

quick_start.md

File metadata and controls

executable file
·
104 lines (65 loc) · 2.73 KB

Quick Start

This software will enable you to create web applications in Java. It provides the bare minimum of what is necessary for that task, plainly and simply. This quick start assumes you have a Posix environment, and have Java 21 or higher installed. If not, see environment

Step 1 - Download the example

Grab this project which demonstrates a simple approach to using Minum.

Using Git:

git clone https://github.com/byronka/minum_usage_example_smaller.git

If you don't have Git, you can download a zip file of Minum, which will need to be unzipped:

https://github.com/byronka/minum_usage_example_smaller/archive/refs/heads/master.zip

Step 2 - run the example

Run this command in its directory:

./mvnw compile exec:java

It will compile and you will be able to view it at http://localhost:8080

Step 3 - Think about the example

Let's look at the code:

An annotated view of the main method

Step 4 - modify the example

  • Stop the server and restart by running ./mvnw compile exec:java
  • Change the path - have it serve content from /hi instead of /hello

Next steps

Now you are ready to go further. If you want a step-by-step tutorial on building a project with Minum from the ground up, check out the getting started tutorial.

Or, you may want to pore through a larger example

Have fun!

Environment

To work with the Minum framework, it is required to have Java 21 or beyond installed. Also, the development has been done in Posix environments, like the Bash or Zsh shells, or Cygwin on Windows.

Try this in your shell:

javac -version

The result should be javac 21 or higher. If it not, check out Step-by-step guide to installing Java on Windows or Java on Mac

After changing environment variables, you must close and reopen your terminal to see the change

Make sure to have the JAVA_HOME environment variable set. Test like this:

echo $JAVA_HOME

The output should be the directory where Java is installed, but not the bin directory where java and javac live. Try this (this command changes directory to JAVA_HOME and then lists the files there):

cd $JAVA_HOME
ls

You should see results like: bin conf include jmods legal lib release

This is why your PATH environment variable should include something like this:

$JAVA_HOME/bin