This repository has been archived by the owner on Sep 19, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Moves docs out of readme and into mkdocs (#41)
- Loading branch information
1 parent
4abb274
commit cb15e2e
Showing
4 changed files
with
44 additions
and
37 deletions.
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,4 @@ | ||
# Keystone-Web | ||
|
||
Keystone-Web is a graphical web interface built on top the [Keystone-API](../keystone-api) REST API. | ||
It facilitates day-to-day administrative activities while empowering HPC user to self administrate common tasks. |
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,36 @@ | ||
# Installation | ||
|
||
To install the Keystone web interface, choose from one of the following options. | ||
|
||
## Using Docker | ||
|
||
Using Docker is the recommended method for building and deploying application instances in production. | ||
|
||
The latest development version can be built directly from source: | ||
|
||
```bash | ||
git clone https://github.com/pitt-crc/keystone-web | ||
docker build -t keystone-web:develop keystone-web | ||
docker run -p 4200:4200 keystone-web:develop | ||
``` | ||
|
||
## Using NPM | ||
|
||
This project requires the Angular CLI utility. | ||
|
||
```bash | ||
npm install -g @angular/cli | ||
``` | ||
|
||
Any remaining dependencies can be installed via `npm` in the standard fashion. | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
Build scripts are provided for building and serving a local instance of the application. | ||
|
||
```bash | ||
npm run build | ||
npm run serve | ||
``` |
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,4 @@ | ||
site_name: Keystone Web | ||
nav: | ||
- Introduction: index.md | ||
- installation.md |