Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add feature section to README #192

Merged
merged 1 commit into from
Jan 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,18 @@ __Jersey Webservice Template__ (__JWT__) is a [JSR 370] webservice template that
through [GitHub templates]. One can think of JWT as the Jersey/Jetty version of [Spring Initializr]. At the end of the
day, JWT helps organization to improve the velocity and quality of their teams' work

Quick Start
✨ Features
-----------

- Out-of-the-box healthcheck endpoint
- Docusaurus-based documentation site freely hosted on GitHub Pages
- Dockerized webservice
- ELK application monitoring
- Flexible webservice configuration

🚀 Quick Start
--------------

Please make sure Docker is installed
([_Installing Docker_](https://docker.qubitpi.org/desktop/setup/install/mac-install/)), then execute this on-click
commands:
Expand Down
10 changes: 6 additions & 4 deletions docs/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,12 @@ applies

:::

That's it. A healthcheck endpoint is now ready at localhost:8080/v1/data/healthcheck. At this point, JWT 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.
After Creating the Repository
-----------------------------

At this point, JWT 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.

- [Development](development)
- [Configuration](configuration)
Expand Down
4 changes: 2 additions & 2 deletions docs/src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ function HomepageHeader() {
{siteConfig.title}
</Heading>
<p className="hero__subtitle">
You can <b><em>innovate</em></b> given the <b><em>right technology</em></b>
We can <b><em>innovate</em></b> given the <b><em>right technology</em></b>
</p>
<div className={styles.buttons}>
<Link
className="button button--secondary button--lg"
to="/docs/intro">
Documentation
Start Adding Business Values
</Link>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ class DockerITSpec extends Specification {
}
}

@Deprecated
private static boolean isLocal() {
return System.properties['os.name'] as String in LOCAL_ENVS
}
Expand Down
Loading