|
1 | | -[](https://github.com/objectcomputing/check-ins/actions/workflows/gradle-build-development.yml) |
| 1 | +[](https://github.com/objectcomputing/check-ins/actions/workflows/gradle-build-develop.yml) |
2 | 2 | [](CODE_OF_CONDUCT.md) |
3 | 3 |
|
4 | 4 | <!-- TOC --> |
@@ -29,99 +29,9 @@ This web application is written in [Micronaut](https://micronaut.io) for uploadi |
29 | 29 |
|
30 | 30 | See [Setting up your environment](https://objectcomputing.github.io/check-ins/getting-started/setup/) for instructions on setting up your development environment. |
31 | 31 |
|
32 | | -# Project setup |
33 | | - |
34 | | -There are two files required to run the application successfully. Both of which must be created and placed in |
35 | | -`src/main/resources/secrets`. |
36 | | - |
37 | | -### directory.json |
38 | | - |
39 | | -This is a simple JSON file containing the identifier for the Google Drive folder into which the uploaded files are to be deposited. |
40 | | - |
41 | | -```json |
42 | | -{ |
43 | | - "upload-directory-id": "GOOGLE_DRIVE_FOLDER_ID" |
44 | | -} |
45 | | -``` |
46 | | - |
47 | | -### credentials.json |
48 | | - |
49 | | -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). |
50 | | - |
51 | | -Note: Be sure that the target Google Drive folder has edit access granted to the service account. |
52 | | - |
53 | | -<!-- the two required files are no longer needed --> |
54 | | - |
55 | 32 | ## Running the application |
56 | 33 |
|
57 | | -#### Installs |
58 | | - |
59 | | -- [Podman](https://podman.io/) |
60 | | -- [Podman-Compose](https://github.com/containers/podman-compose) |
61 | | - |
62 | | -#### Building |
63 | | - |
64 | | -1. Start the database in a Podman container: |
65 | | - - Initialize and start a Podman VM: |
66 | | - ```shell |
67 | | - $ podman machine init |
68 | | - $ podman machine start |
69 | | - ``` |
70 | | - - Start the Podman container: |
71 | | - ```shell |
72 | | - $ podman-compose up |
73 | | - ``` |
74 | | -2. In a different terminal, execute the following commands : |
75 | | - |
76 | | - - On Bash/Zsh - |
77 | | - |
78 | | - ```sh |
79 | | - $ OAUTH_CLIENT_ID=<Insert_Client_ID> OAUTH_CLIENT_SECRET=<Insert_Client_Secret> MICRONAUT_ENVIRONMENTS=local ./gradlew build |
80 | | - ``` |
81 | | - |
82 | | - ```sh |
83 | | - $ ./gradlew assemble |
84 | | - ``` |
85 | | - |
86 | | - ```sh |
87 | | - $ OAUTH_CLIENT_ID=<Insert_Client_ID> OAUTH_CLIENT_SECRET=<Insert_Client_Secret> MICRONAUT_ENVIRONMENTS=local ./gradlew run |
88 | | - ``` |
89 | | - |
90 | | - - On Powershell/Command-Line - |
91 | | - Set the following environment variables - |
92 | | - ```sh |
93 | | - MICRONAUT_ENVIRONMENTS=local |
94 | | - OAUTH_CLIENT_ID=<Client_ID> |
95 | | - OAUTH_CLIENT_SECRET=<Client_Secret> |
96 | | - ``` |
97 | | - Build and run the application - |
98 | | - ```sh |
99 | | - $ gradlew build |
100 | | - ``` |
101 | | - ```sh |
102 | | - $ gradlew assemble |
103 | | - ``` |
104 | | - ```sh |
105 | | - $ gradlew run |
106 | | - ``` |
107 | | - |
108 | | -3. Open the browser to run the application at `http://localhost:8080` |
109 | | -4. Access swagger-UI at - `http://localhost:8080/swagger-ui` |
110 | | - |
111 | | -# Testing |
112 | | - |
113 | | -1. To run the server tests, run the following: |
114 | | - ```sh |
115 | | - $ ./gradlew :server:check |
116 | | - ``` |
117 | | -2. To run the UI tests, run the following: |
118 | | - ```sh |
119 | | - $ ./gradlew :web-ui:check |
120 | | - ``` |
121 | | -3. To update snapshots, run the following: |
122 | | - ```sh |
123 | | - $ cd web-ui && yarn test -u |
124 | | - ``` |
| 34 | +See [Running the Application](https://objectcomputing.github.io/check-ins/getting-started/running/) for instructions on running the application locally. |
125 | 35 |
|
126 | 36 | # Contributing |
127 | 37 |
|
|
0 commit comments