Skip to content

Commit 5035d43

Browse files
committed
Updating ReadMe
1 parent a29a930 commit 5035d43

File tree

2 files changed

+28
-8
lines changed

2 files changed

+28
-8
lines changed

README.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Angular frontend for RiverSurf.app.
44

5-
"Plan, keep track and stay up to date at river surf events."
5+
*"Plan, keep track and stay up to date at river surf events."*
66

77
Team:
88

@@ -11,13 +11,33 @@ Team:
1111
* Marius Stalder @stalm12
1212
* Raphael Gerber @gerbr19
1313

14-
## Test
15-
Each commit to the develop branch will trigger the build and deploy pipeline for the test environment.
14+
![RiverSurf.app Result View](src/assets/images/riversurf-app.png)
1615

17-
[test.riversurf.app](https://test.riversurf.app)
16+
## Live Demo
1817

19-
## Deployment
20-
### .htaccess
21-
we deploy to azure webservices (PHP) so its a linux machine (appache web server) -> .htaccess
18+
You can visit the application at [test.riversurf.app](https://test.riversurf.app).
2219

23-
[Angular Deployment Guide](https://angular.io/guide/deployment)
20+
21+
## Administrator Access
22+
23+
[Login](https://test.riversurf.app/login) with Username: `fritz32`, Password: `123456789`.
24+
25+
26+
## Installation
27+
28+
Clone the repository: `git clone https://gitlab.ti.bfh.ch/aligmara/riversurf-angular.git`.
29+
30+
Run `npm ci` to install all required modules.
31+
32+
Run `npm start` or `ng serve`.
33+
34+
## Build
35+
36+
Run `npm run build` or `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
37+
38+
39+
## Progressive Web App (PWA)
40+
41+
To test the PWA locally, you need to build the project. Furthermore, you need to install an HTTP-Server, e.g. by running `npm install http-server -g`.
42+
43+
After that, you need to serve the build by running `http-server -p <desired-port-number>`

src/assets/images/riversurf-app.png

462 KB
Loading

0 commit comments

Comments
 (0)