Skip to main content

Getting Started

caution

Before proceeding, it is important to note that we DO NOT support Spring/Spring Boot paradigm. FastWS runs as a JAX-RS webservice backed by its reference implementation [Jersey] running as a WAR inside Jetty container.

More info about difference between JAX-RS and Spring can be found in this thread

To use FastWS as the basis for a webservice, we start by creating a repository using the template on GitHub.

Creating a Repository from GitHub Template

We can click on this link to generate a repository using the template: Create a new repository from QubitPi/fast-ws. Alternatively, we can visit the fast-ws repository on GitHub and click on the "Use this template" button on the top-right.

In both cases, the next steps are:

  1. Enter a name for the new repository.
  2. Uncheck "Include all branches".
  3. Click on "Create repository from template".

For more details on how to create repositories using template, read the article on the GitHub website: Creating a repository from a template.

caution

If the repository is public, GitHub offers unlimited free build minutes. If it's a private repository, however, billing policy applies

After Creating the Repository

At this point, FastWS has generated a Java webservice project with just what we need to start quickly. Developer can now start adding business value and get work done much faster in a standard way. The following sections of this documentation contain further details on how to proceed next.