README.md

eoepca-portal

Web application using AngularJS and Angular Material to visually interact with the Identity. Interacts with Identity API.
Explore the docs »
View Demo · Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
  • Code scaffolding
  • Build
  • Running unit tests
  • Running end-to-end tests
  • Running with Docker
  • Further help
• Documentation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Web application using AngularJS and Angular Material to visually interact with the Identity.
Interacts with Identity API.

Built With

• AngularJS + Angular Material

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Docker
• Python

Installation

1. Get into EOEPCA's development environment

vagrant ssh

3. Clone the repo

git clone https://github.com/EOEPCA/eoepca-portalgit

4. Change local directory

cd eoepca-portal

5. Run development server

npm install
ng serve

Navigate to http://localhost:4200/. The application will automatically reload if you change any of the source files.

Code scaffolding

To generate a new componente:

ng generate component component-name

You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Build the project with:

npm install
ng build

The build artifacts will be stored in the dist/ directory.

Build the production Docker image with:

ng build --configuration=production
docker build . -f Dockerfile.production -t eoepca-portal

Run with:

docker run --rm -dp 4200:80 --name eoepca-portal --network eoepcanetwork eoepca-portal

Running unit tests

Execute unit tests via Karma:

ng test

Running end-to-end tests

Execute end-to-end tests via a platform of your choice:

ng e2e

To use this command, you need to first add a package that implements end-to-end testing capabilities.

Running with Docker

Local develop

docker build . --progress=plain -t eoepca-portal:develop
docker run --rm -dp 4200:4200 --name eoepca-portal --network eoepcanetwork eoepca-portal:develop

Local Production

docker build . -f Dockerfile.production --progress=plain -t eoepca-portal:production
docker run --rm -dp 4200:8080 --name eoepca-portal --network eoepcanetwork eoepca-portal:production

Remote develop

docker run --rm -dp 4200:4200 --name eoepca-portal --network eoepcanetwork ghcr.io/eoepca/eoepca-portal:develop

Remote Production

docker run --rm -dp 4200:8080 --name eoepca-portal --network eoepcanetwork ghcr.io/eoepca/eoepca-portal:master

Portal is available at localhost:4200.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.

Documentation

The component documentation can be found at https://eoepca.github.io/eoepca-portal/.

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the Apache-2.0 License. See LICENSE for more information.

Contact

EOEPCA mailbox

Project Link: https://github.com/EOEPCA/eoepca-portal

Acknowledgements

• README.md is based on this template by Othneil Drew.