From 81e7b2b7dd311d7e937a44425f7b6d1d18982d40 Mon Sep 17 00:00:00 2001 From: Karan Sheth Date: Tue, 6 Feb 2024 10:31:01 -0500 Subject: [PATCH 1/5] Create README.md --- README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..961eb7e70 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# Bento Frontend Installation Guide + +🍱 Welcome to the Bento Frontend Installation Guide! 🍱 + +**Prerequisites:** +- Node 16.17.1 +- NPM 8.15.0 +- Lerna 6.6.7 + +**Installation Steps:** + +1. **Clone Bento Frontend Repository:** + ```bash + git clone https://github.com/CBIIT/bento-frontend.git + cd bento-frontend + ``` + +2. **Install Node Modules:** + ```bash + npm install + ``` + +3. **Navigate to Nginx Configuration Directory:** + ```bash + cd packages/bento-frontend/nginx/ + ``` + +4. **Install Nginx:** + - Use the provided guide "local-nginx-setup-for-frontend.txt" to install Nginx on your Linux-based system. + +5. **Return to the Root Folder:** + ```bash + cd ../../../ + ``` + +6. **Run Lerna to Start Bento Frontend:** + ```bash + lerna run start + ``` + +🚀 Following these steps should have Bento Frontend up and running on your system. Enjoy exploring Bento! 🚀 From 591495c0d46f55f9daacf0fc63749e0206107d8e Mon Sep 17 00:00:00 2001 From: Karan Sheth Date: Tue, 6 Feb 2024 10:42:57 -0500 Subject: [PATCH 2/5] Update README.md --- README.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 961eb7e70..5399d0087 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,19 @@ # Bento Frontend Installation Guide 🍱 Welcome to the Bento Frontend Installation Guide! 🍱 - -**Prerequisites:** +--- +### Prerequisites: - Node 16.17.1 - NPM 8.15.0 - Lerna 6.6.7 -**Installation Steps:** +### Lerna Installation Steps: + +1. **Install Lerna globally:** + ```bash + npm install -g lerna@6.6.2 + +### Bento Frontend Installation Steps: 1. **Clone Bento Frontend Repository:** ```bash @@ -38,4 +44,16 @@ lerna run start ``` +--- + +### Creating Custom Applications: + +🛠ī¸ If you want to create a custom application using Bento, you can use the following command: + +```bash +npx @bento-core/create-bento-app +``` + +ℹī¸ This command will scaffold a new Bento application for you to customize according to your needs. + 🚀 Following these steps should have Bento Frontend up and running on your system. Enjoy exploring Bento! 🚀 From 4fb69d05340a4046fa2bfa9051e63103178903bd Mon Sep 17 00:00:00 2001 From: Karan Sheth Date: Tue, 12 Mar 2024 09:40:48 -0400 Subject: [PATCH 3/5] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5399d0087..af89d5f3b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Bento Frontend Installation Guide +> ℹī¸ **NOTE:** This guide is only for Bento Framework development. If you would like to consume Bento Framework for your project, please refer to the [How get my copy of Bento Frontend?](https://github.com/CBIIT/bento-frontend?tab=readme-ov-file#creating-custom-applications). + 🍱 Welcome to the Bento Frontend Installation Guide! 🍱 --- ### Prerequisites: @@ -46,7 +48,7 @@ --- -### Creating Custom Applications: +### Creating Custom Applications (How get my copy of Bento Frontend?): 🛠ī¸ If you want to create a custom application using Bento, you can use the following command: From aceba87cd94bc3bd270327ba6edf3ae684d6a770 Mon Sep 17 00:00:00 2001 From: Karan Sheth Date: Tue, 12 Mar 2024 09:44:07 -0400 Subject: [PATCH 4/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index af89d5f3b..31e6e6a45 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Bento Frontend Installation Guide -> ℹī¸ **NOTE:** This guide is only for Bento Framework development. If you would like to consume Bento Framework for your project, please refer to the [How get my copy of Bento Frontend?](https://github.com/CBIIT/bento-frontend?tab=readme-ov-file#creating-custom-applications). +> ℹī¸ **NOTE:** This guide is only for Bento Framework development. If you would like to consume Bento Framework for your project, please refer to the [How get my copy of Bento Frontend?](https://github.com/CBIIT/bento-frontend?tab=readme-ov-file#creating-custom-applications-how-get-my-copy-of-bento-frontend). 🍱 Welcome to the Bento Frontend Installation Guide! 🍱 --- From 8daddefbf3247af43c3b178e3a6aa497a9129ee4 Mon Sep 17 00:00:00 2001 From: Michael Fleming Date: Tue, 30 Apr 2024 10:59:05 -0400 Subject: [PATCH 5/5] Update Dockerfile --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index 514cf5618..634c47bf6 100644 --- a/Dockerfile +++ b/Dockerfile @@ -8,7 +8,7 @@ RUN NODE_OPTIONS="--max-old-space-size=4096" npm install RUN NODE_OPTIONS="--max-old-space-size=4096" npx lerna run build -FROM nginx:1.23.3-alpine +FROM nginx:1.23.3-alpine AS fnl_base_image COPY --from=build /usr/src/app/packages/bento-frontend/dist /usr/share/nginx/html COPY --from=build /usr/src/app/conf/inject.template.js /usr/share/nginx/html/inject.template.js