Skip to content

Commit

Permalink
Updated project description and added CI status badge
Browse files Browse the repository at this point in the history
Added a simple description of the project including the template used to create
it.

Detailed how to run the project for development and how to package an run in
production.

Added a CircleCI status badge from the Markdown provided from the CircleCI
website.
  • Loading branch information
practicalli-johnny committed Sep 22, 2018
1 parent f7912e1 commit 2647704
Showing 1 changed file with 29 additions and 5 deletions.
34 changes: 29 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,43 @@
# status-monitor

FIXME
[![CircleCI](https://circleci.com/gh/jr0cket/webapp-status-monitor.svg?style=svg)](https://circleci.com/gh/jr0cket/webapp-status-monitor)

## Prerequisites

You will need [Leiningen][] 2.0.0 or above installed.
A simple Status Monitor that mocks the type of information that is typically useful from several sources of monitoring systems.

[leiningen]: https://github.com/technomancy/leiningen
The main purpose is a to demonstrate a simple server side website with Scalable Vector Graphics.

## Project Creation

The project was created with [Leiningen](https://github.com/technomancy/leiningen) 2.8.1, using the compojure template.

```bash
lein new compojure status-monitor
```

## Running

To start a web server for the application, run:

lein ring server


## Deploying

Create an uberjar using the `lein-ring` plugin for Leiningen by using the following task

```bash
lein ring uberjar
```

Then run the application on the comand line as follows, replacing version for the generated version

```bash
java -jar target/status-monitor-version-standalone.jar
```

## License

Copyright © 2018 FIXME
Copyright © 2018 jr0cket

Creative Commons Attribution Share-Alike 4.0 International

0 comments on commit 2647704

Please sign in to comment.