Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
rishabh9 committed May 21, 2020
1 parent 192a0f1 commit fd10136
Showing 1 changed file with 74 additions and 14 deletions.
88 changes: 74 additions & 14 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,30 +12,21 @@ A minimal implementation of Nexus repository to practice Vert.x
* [x] Jitpack.

.Snapshots
* [x] Enable snapshots.
* [x] Enable snapshot repositories of above mirrors.

.Publishing artifacts
* [ ] Publish artifacts to Kumoru. (_Contemplating_)
* [x] Publish artifacts to Kumoru.

.HTTP methods supported
* [x] GET
* [x] PUT

== Pre-Requisites

1. JDK 11
1. Java 11
2. Docker

== Building and Running Locally

To build your application:
```
./gradlew clean build
```

To package your application into Docker container:
```
./gradlew jibDockerBuild
```
== Running the server

To run your application:
```
Expand All @@ -52,4 +43,73 @@ docker run -e KUMORU_ACCESS_LOG=true -p 8888:8888 -v /tmp/repo:/srv/repo rishabh

> All logs are written to the `STDOUT`.

== Configuring Maven

.Mirroring
Edit Maven's `settings.xml` and add a `<mirror>`:

```
<mirrors>
<mirror>
<id>kumoru</id>
<mirrorOf>*</mirrorOf>
<name>Kumoru - A minimal Nexus repository</name>
<url>http://localhost:8888</url>
</mirror>

</mirrors>
```

.Publishing

In your `pom.xml` add

```
<distributionManagement>
<repository>
<id>kumoru</id>
<name>Kumoru - A minimal Nexus repository</name>
<url>http://localhost:8888</url>
</repository>
</distributionManagement>
```

== Configuring Gradle

.Mirroring

Add to you `build.gradle`

```
repositories {
maven {
url: "http://localhost:8080"
}
}
```

.Publishing

Add to your `build.gradle`

```
publishing {
repositories {
maven {
url: "http://localhost:8080"
}
}
}
```

== Building the code

To build your application:
```
./gradlew clean build
```

To package your application into Docker container:
```
./gradlew jibDockerBuild
```

0 comments on commit fd10136

Please sign in to comment.