diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..7234eb603131811b4982111c0e33d3700dba3a45 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +<div align="center"> + <a href="https://docs.nmaas.eu/"> + <img src="docs/nmaas-logo-blue.png" alt="Logo" width="206" height="48"> + </a> + + <h3 align="center">NMaaS Platform (Front-end)</h3> + + <h4 align="center">Open-source multi-tenant platform for effortless, orchestrated deployment of software tools and applications on top of Kubernetes</h4> + + <p align="center"> + <br /> + <a href="https://docs.nmaas.eu/">Explore documentation</a> + · + <a href="https://github.com/nmaas-platform/nmaas-portal/issues">Report Bug</a> + · + <a href="https://github.com/nmaas-platform/nmaas-portal/issues">Request Feature</a> + </p> +</div> + +## NMaaS Portal Component + +[NMaaS Portal](https://github.com/nmaas-platform/nmaas-portal) represents the front-end application of NMaaS that consumes the REST API offered by NMaaS Platform. NMaaS Portal is a Angular based application that is run in user's browser. + +### NMaaS Portal Development + +Explore the NMaaS Portal [development and deployment](docs/DEVELOPMENT.md) documentation. + +## Get in Touch + +Interested users can use the following mailing lists to subscribe to news about NMaaS, get in touch with the NMaaS development team, or other NMaaS users: + +- [nmaas-announce@lists.geant.org](mailto:nmaas-announce@lists.geant.org) - public mailing list for announcements shared by the NMaaS team with the community ([subscribe here](https://lists.geant.org/sympa/info/nmaas-announce)) +- [nmaas@lists.geant.org](mailto:nmaas@lists.geant.org) - private mailing list for contacting the NMaaS core team members +- [nmaas-users@lists.geant.org](mailto:nmaas-users@lists.geant.org) - public mailing lists for discussions related to NMaaS usage and development ([subscribe here](https://lists.geant.org/sympa/info/nmaas-users)) diff --git a/readme.md b/docs/DEVELOPMENT.md similarity index 68% rename from readme.md rename to docs/DEVELOPMENT.md index 0d7c42c8c9afe9753af6707dc883ef3159ea2153..8ec5de72333e291e43ebd076d150090952d8db43 100644 --- a/readme.md +++ b/docs/DEVELOPMENT.md @@ -1,7 +1,5 @@ # NMaaS Portal (GUI) -### Web-based GUI for browsing, subscription and deployment of applications offered by the NMaaS Platform - ### Technologies --- @@ -15,11 +13,11 @@ See `package.json` for detailed package list. ### Prerequisites --- - + Install node and npm (min version is node v14, but suggested is v16) - + Install git - + Clone project and run `npm install` in project *root* directory - + (running on server) Build project using `ng build` and deploy using http server of your choice - + (running tests) Chrome is required for running tests, however `karma-chrome-launcher` should download Chrome automatically if it is not detected. Run test using `npm test` or `npm test-headless`. See `package.json` for detailed test commands. ++ Install node and npm (min version is node v14, but suggested is v16) ++ Install git ++ Clone project and run `npm install` in project *root* directory ++ (running on server) Build project using `ng build` and deploy using http server of your choice ++ (running tests) Chrome is required for running tests, however `karma-chrome-launcher` should download Chrome automatically if it is not detected. Run test using `npm test` or `npm test-headless`. See `package.json` for detailed test commands. ### Running NMaaS Portal locally --- @@ -30,17 +28,17 @@ Note: First run requires entering `npm install` command in order to install all ### Running NMaaS Portal on dedicated machine --- - In order to run NMaaS Portal on dedicated machine perform the following steps: - + Build the NMaaS Portal by running `gradlew clean build` in the reactor directory. - - In order to build for production environment use additional option `--configuration production` - + The output archive `nmaas-portal-x.x.x.zip` file is created in `nmaas-portal/build/distributions` directory. - + Run the http server in `nmaas-portal/build/app` - - `nohup angular-http-server -p 9009 -s --cors > nmaas-portal.log 2> Error.err < /dev/null &` +In order to run NMaaS Portal on dedicated machine perform the following steps: ++ Build the NMaaS Portal by running `gradlew clean build` in the reactor directory. + - In order to build for production environment use additional option `--configuration production` ++ The output archive `nmaas-portal-x.x.x.zip` file is created in `nmaas-portal/build/distributions` directory. ++ Run the http server in `nmaas-portal/build/app` + - `nohup angular-http-server -p 9009 -s --cors > nmaas-portal.log 2> Error.err < /dev/null &` ### Lunching tests --- Run `./gradlew run testCoverage` in this directory. -Results of executed tests are displayed on screen. +Results of executed tests are displayed on screen. More information about code quality (including code coverage, test status) are available in `nmaas-portal/coverage/index.html` ### Default settings @@ -52,7 +50,7 @@ NMaaS Portal and Platform URLs: Admin user: + username: `admin` + password: `admin` - + ### Building and uploading NMaaS Portal Docker image --- In order to build the NMaaS Portal Docker image first alter the `build_and_publish.sh` script with custom REPOSITORY, PACKAGE and TAG values and execute `build_and_publish.sh` to automatically build and publish `nmaas-portal` image to selected Docker repository. diff --git a/docs/nmaas-logo-blue.png b/docs/nmaas-logo-blue.png new file mode 100644 index 0000000000000000000000000000000000000000..2ab81d686b5da7b544f7f93da742ab393ac50fa4 Binary files /dev/null and b/docs/nmaas-logo-blue.png differ diff --git a/docs/nmaas-logo-white.png b/docs/nmaas-logo-white.png new file mode 100644 index 0000000000000000000000000000000000000000..3226b4d55678026b0e8ee044d2f3a8c9f5f9745b Binary files /dev/null and b/docs/nmaas-logo-white.png differ