Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mkimberlin authored Oct 17, 2024
1 parent 513ef8f commit d31d799
Showing 1 changed file with 2 additions and 92 deletions.
94 changes: 2 additions & 92 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![Gradle Build & Deploy - Develop](https://github.com/objectcomputing/check-ins/actions/workflows/gradle-build-development.yml/badge.svg)](https://github.com/objectcomputing/check-ins/actions/workflows/gradle-build-development.yml)
[![Gradle Build & Deploy - Develop](https://github.com/objectcomputing/check-ins/actions/workflows/gradle-build-develop.yml/badge.svg)](https://github.com/objectcomputing/check-ins/actions/workflows/gradle-build-develop.yml)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)

<!-- TOC -->
Expand Down Expand Up @@ -29,99 +29,9 @@ This web application is written in [Micronaut](https://micronaut.io) for uploadi

See [Setting up your environment](https://objectcomputing.github.io/check-ins/getting-started/setup/) for instructions on setting up your development environment.

# Project 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.

```json
{
"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](https://cloud.google.com/iam/docs/creating-managing-service-account-keys).

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

<!-- the two required files are no longer needed -->

## Running the application

#### Installs

- [Podman](https://podman.io/)
- [Podman-Compose](https://github.com/containers/podman-compose)

#### Building

1. Start the database in a Podman container:
- Initialize and start a Podman VM:
```shell
$ podman machine init
$ podman machine start
```
- Start the Podman container:
```shell
$ podman-compose up
```
2. In a different terminal, execute the following commands :

- On Bash/Zsh -

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

```sh
$ ./gradlew assemble
```

```sh
$ 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 -
```sh
MICRONAUT_ENVIRONMENTS=local
OAUTH_CLIENT_ID=<Client_ID>
OAUTH_CLIENT_SECRET=<Client_Secret>
```
Build and run the application -
```sh
$ gradlew build
```
```sh
$ gradlew assemble
```
```sh
$ gradlew run
```

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

# Testing

1. To run the server tests, run the following:
```sh
$ ./gradlew :server:check
```
2. To run the UI tests, run the following:
```sh
$ ./gradlew :web-ui:check
```
3. To update snapshots, run the following:
```sh
$ cd web-ui && yarn test -u
```
See [Running the Application](https://objectcomputing.github.io/check-ins/getting-started/running/) for instructions on running the application locally.

# Contributing

Expand Down

0 comments on commit d31d799

Please sign in to comment.