From b85f86a32d8cfc62d666fc30cfafc69f548f2345 Mon Sep 17 00:00:00 2001 From: Adam Thorpe <52922030+adam-thorpe@users.noreply.github.com> Date: Tue, 5 May 2020 10:08:41 +0100 Subject: [PATCH 1/2] Add setup details to documentation --- CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a1742ade..c4274f64 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ ## Overview -The AdoptOpenJDK API V3 is a Kotlin application (fronted by Swagger and OpenAPI) which makes +The AdoptOpenJDK API V3 is a Kotlin application (frontend by Swagger and OpenAPI) which makes calls via the GitHub API in order to retrieve AdoptOpenJDK binaries and metadata. Since the GitHub API is rate limited we use MongoDB as a caching mechanism. @@ -21,6 +21,12 @@ eventually merge into `master` for a real Production deployment. Java 11 is a requirement to build the project. +You also need mongod installed. If you are on mac, I used this guide https://zellwk.com/blog/install-mongodb/ which uses homebrew. + +### Set-up + +If you want to use the updater tool to add entries into mongo, you need to generate a github token, which can be done here: https://github.com/settings/tokens. It doesn't need any specific permissions. Once you have a token generated, create a file at ~/.adopt_api/token.properties and type token=your-token-here + ### Build Tool We use a Maven Wrapper (mvnw) to ensure that there's a consistent, repeatable build. The From ee8a820dbe95f7c2e4bd176f32799702f883c898 Mon Sep 17 00:00:00 2001 From: Adam Thorpe <52922030+adam-thorpe@users.noreply.github.com> Date: Thu, 7 May 2020 14:03:29 +0100 Subject: [PATCH 2/2] Update mongodb info --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c4274f64..c8a20446 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,11 +21,11 @@ eventually merge into `master` for a real Production deployment. Java 11 is a requirement to build the project. -You also need mongod installed. If you are on mac, I used this guide https://zellwk.com/blog/install-mongodb/ which uses homebrew. +### Optional Set-up -### Set-up +If you want to use the updater tool to add entries into the database, you need to generate a github token, which can be done here: https://github.com/settings/tokens. It doesn't need any specific permissions. Once you have a token generated, create a file at ~/.adopt_api/token.properties and type token=your-token-here -If you want to use the updater tool to add entries into mongo, you need to generate a github token, which can be done here: https://github.com/settings/tokens. It doesn't need any specific permissions. Once you have a token generated, create a file at ~/.adopt_api/token.properties and type token=your-token-here +The production server uses mongodb to store data, however you can also use Fongo. If you would like to install mongodb and are on mac, I used this guide https://zellwk.com/blog/install-mongodb/ which utilises homebrew. ### Build Tool