Skip to content

Commit c3a049c

Browse files
committed
Update to readmes, gitignore, and remove vestigial NotificationSlider from default.vue
1 parent 83ac062 commit c3a049c

File tree

5 files changed

+32
-36
lines changed

5 files changed

+32
-36
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,15 @@ Missions adapt MMTC to their mission by accomplishing the following two steps:
3333

3434
## Quick Start
3535

36-
MMTC requires Red Hat Enterprise Linux (RHEL) 8 or 9 and Java 8. After cloning the repository and running `./gradlew build`, two MMTC installation options are available:
36+
Build requirements:
37+
- Red Hat Enterprise Linux (RHEL) 8 or 9 on an x86-64 host
38+
- Java 17
39+
40+
Runtime requirements:
41+
- Red Hat Enterprise Linux (RHEL) 8 or 9 on an x86-64 host
42+
- Java 8 for all components except the web application, which requires Java 17
43+
44+
After cloning the repository and running `./gradlew build`, two MMTC installation options are available:
3745

3846
### Demo
3947

@@ -45,7 +53,6 @@ For users who wish to experiment with MMTC’s behavior and functionality withou
4553

4654
See the "Quick Start Guide" section of the User Guide for complete instructions.
4755

48-
4956
### Installation
5057

5158
To create a traditional clean installation of MMTC that is ready for configuration and adaptation:
@@ -59,6 +66,6 @@ For further information, please see the User Guide at `docs/User_Guide.adoc`, wh
5966

6067
## Copyright
6168

62-
© 2024 The Johns Hopkins University Applied Physics Laboratory LLC
69+
© 2025 The Johns Hopkins University Applied Physics Laboratory LLC
6370

6471
This work was performed for the Jet Propulsion Laboratory, California Institute of Technology, sponsored by the United States Government under the Prime Contract 80NM0018D00004 between the Caltech and NASA under subcontract number 1658085.

mmtc-webapp-ui/README.md

Lines changed: 18 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -3,44 +3,31 @@
33
Stack:
44
- Vue 3
55
- Nuxt 3
6-
- NuxtUI (3)
6+
- NuxtUI 4
77

8-
## Initial setup notes:
8+
## Development
99

10-
Followed https://nuxt.com/docs/3.x/getting-started/installation.
10+
### Requirements
1111

12-
1. Installed [Node](https://nodejs.org/en/download)
13-
1. As of the time of writing this, I installed node v22.19.0 and npm 10.9.3
14-
2. `npm create nuxt@latest mmtc-webapp-ui`
15-
3. Selected: npm for package manager, and installed @nuxt/ui and @nuxt/test-utils
12+
- [Node](https://nodejs.org/en/download)
13+
- Tested to work with node v22.19.0
14+
- [PNPM](https://get.pnpm.io)
15+
- Tested to work with pnpm 10.18.1
1616

17-
Latest, ran:
18-
19-
```
20-
# Download and install nvm:
21-
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
22-
23-
# in lieu of restarting the shell
24-
\. "$HOME/.nvm/nvm.sh"
25-
26-
# Download and install Node.js:
27-
nvm install 22
28-
29-
# Verify the Node.js version:
30-
node -v # Should print "v22.20.0".
17+
## Building
3118

32-
# Verify npm version:
33-
npm -v # Should print "10.9.3".
19+
```sh
20+
# first time only:
21+
pnpm install
3422

23+
# to start a development server with hot reloading:
24+
pnpm dev
3525

26+
# to generate static bundle:
27+
npx nuxt generate
3628
```
3729

38-
## Building
39-
40-
```
41-
# first time only:
42-
npm install
30+
## Notes
4331

44-
# to regenerate:
45-
npx nuxt generate
46-
```
32+
This web application was originally made using the following:
33+
- https://nuxt.com/docs/3.x/getting-started/installation.

mmtc-webapp-ui/mmtc-webapp-ui/app/composables/.gitkeep

Whitespace-only changes.

mmtc-webapp-ui/mmtc-webapp-ui/app/layouts/default.vue

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,5 @@ function rightSidebarToggle() {
141141

142142
<slot />
143143

144-
<NotificationsSlideover />
145144
</UDashboardGroup>
146145
</template>

mmtc-webapp/.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11

2-
### copied built webapp resources ###
2+
### contains copied webapp static bundle ###
33
src/main/resources/static/
4+
5+
### contains copied user doc PDF ###
6+
src/main/resources/docs

0 commit comments

Comments
 (0)