ladybug / check-ins

• Check-ins
• Project Links
• Setup
  • directory.json
  • credentials.json
  • Running the application
• Contributing

Check-ins

This web application is written in Micronaut for uploading files and tracking skill set of team members. This application will also be used for PDL checkins and to auto-generate resumes from the skill set.

Project Links

Project Document: *TBA*

Project Board: Board

Environments: *TBA*

Setup

There are two files required to run the application successfully. Both of which must be created and placed in src/main/resources/secrets

directory.json

This is a simple JSON file containing the identifier for the Google Drive folder into which the uploaded files are to be deposited.

{
    "upload-directory-id": "GOOGLE_DRIVE_FOLDER_ID"
}

credentials.json

This JSON file should create the generated credentials for a service account that has access to write to the identified Google Drive folder. Information on configuring GCP service account credentials can be found here.

Note: Be sure that the target Google Drive folder has edit access granted to the service account.

Running the application

Installs

• Docker

Building

1. Start the database in a Docker container by running docker-compose up in a terminal.
2. In a different terminal, execute the following commands :

   • On Bash/Zsh -

     $ OAUTH_CLIENT_ID=<Insert_Client_ID> OAUTH_CLIENT_SECRET=<Insert_Client_Secret> MICRONAUT_ENVIRONMENTS=local ./gradlew build

     $ ./gradlew assemble

     $ OAUTH_CLIENT_ID=<Insert_Client_ID> OAUTH_CLIENT_SECRET=<Insert_Client_Secret> MICRONAUT_ENVIRONMENTS=local ./gradlew run

   • On Powershell/Command-Line - Set the following environment variables -

     MICRONAUT_ENVIRONMENTS=local
     OAUTH_CLIENT_ID=<Client_ID>
     OAUTH_CLIENT_SECRET=<Client_Secret>

     Build and run the application -

     $ gradlew build

     $ gradlew assemble

     $ gradlew run

3. Open the browser to run the application at http://localhost:8080
4. Access swagger-UI at - http://localhost:8080/swagger-ui

Contributing

Contributing