Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rzrbld committed Jan 20, 2020
1 parent 7277537 commit c78b9d8
Showing 1 changed file with 25 additions and 8 deletions.
33 changes: 25 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Adminio-ui
This is a Web UI for [minio](https://min.io) s3 server.
Web UI works on top of REST API - [adminio-API](https://github.com/rzrbld/adminio-api)
This is a Web UI for [minio](https://min.io) s3 server.
Web UI works on top of REST API - [adminio-API](https://github.com/rzrbld/adminio-api)
Build with [Angular](https://angular.io) and [mdbootstrap](https://mdbootstrap.com)

### Web UI abilities:
Expand All @@ -14,7 +14,7 @@ Build with [Angular](https://angular.io) and [mdbootstrap](https://mdbootstrap.c

### Extra features:
- create multiple buckets at once
- full editable policy constructor
- fully editable policy constructor
- copy policies


Expand All @@ -24,7 +24,7 @@ Build with [Angular](https://angular.io) and [mdbootstrap](https://mdbootstrap.c

it will bring up:

- minio server on 9000 port
- minio server on 9000 port
- adminio API on 8080 port
- adminio UI on 80 port

Expand All @@ -33,17 +33,34 @@ after that you can go to `` http://localhost `` and try out
### Run in docker
Before running make sure that you minio server and adminio-api is started.

`` docker run rzrbld/adminio-ui:0.2.1 ``
`` docker run rzrbld/adminio-ui:latest ``

This example run only for test purposes, unless you running UI and API of adminio on the same server.

In real life cases you'll need to change a `` baseUrl `` variable `` on line 12 `` in file `` src/app/api.service.ts ``
by default `` baseUrl variable `` is set to `` http://localhost:8080 ``. And then rebuild a docker image.
### Run in real environment
#### Docker
In real life cases you'll need to change two environment variables at `` Dockerfile `` - `` API_BASE_URL `` which points to [adminio-api](https://github.com/rzrbld/adminio-api) REST endpoint and `` ADMINIO_PROD `` which can be set to `` true `` or `` false ``. And then rebuild a docker image.

#### npm build
Method that described above also works if you build with `` npm run build ``.
In this case example command will be look like this ``$ export API_BASE_URL=http://example.com:8099 && export ADMINIO_PROD=false && npm run build `` after that distributive can be obtaned at `` ./dist `` folder.

#### ng build
If you build project with `` ng build `` you will need to set [adminio-api](https://github.com/rzrbld/adminio-api) REST endpoint at `` apiBaseUrl `` variable in file `` src/environments/environment.ts `` or `` src/environments/environment.prod.ts ``.

by default `` apiBaseUrl variable `` is set to `` http://localhost:8080 ``.

### Developement
#### npm start
in this case example command will be look like this - ``$ export API_BASE_URL=http://example.com:8099 && export ADMINIO_PROD=false && npm start `` it will bring up a dev server on port 4201. Navigate to `http://localhost:4201/`. The app will automatically reload if you change any of the source files.

#### ng serve
you will need to set [adminio-api](https://github.com/rzrbld/adminio-api) REST endpoint at `` apiBaseUrl `` variable in file `` src/environments/environment.ts `` or `` src/environments/environment.prod.ts `` then run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.

## screenshot
![screenshot1](https://raw.githubusercontent.com/rzrbld/adminio-ui/master/images/screenshot1.png)

## Default angular README
## Default angular README

This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 8.3.8.

Expand Down

0 comments on commit c78b9d8

Please sign in to comment.