-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
62 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
# 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-how-get-my-copy-of-bento-frontend). | ||
🍱 Welcome to the Bento Frontend Installation Guide! 🍱 | ||
--- | ||
### Prerequisites: | ||
- Node 16.17.1 | ||
- NPM 8.15.0 | ||
- Lerna 6.6.7 | ||
|
||
### Lerna Installation Steps: | ||
|
||
1. **Install Lerna globally:** | ||
```bash | ||
npm install -g [email protected] | ||
|
||
### Bento Frontend 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 | ||
``` | ||
|
||
--- | ||
|
||
### 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: | ||
|
||
```bash | ||
npx @bento-core/create-bento-app <My Application Name> | ||
``` | ||
|
||
ℹ️ 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! 🚀 |