The environment:
- IDE: Eclipse Oxygen latest version with JDK 8 from https://www.eclipse.org/downloads/
- Optional Eclipse extension: Spring Suit
- Database: Mariadb from https://downloads.mariadb.org/
- Mariadb client (not available for MacOS): heidisql from https://www.heidisql.com/download.php
Getting started:
- Create a database using the ako_db.sql script from the root folder (can use heidisql or command line)
- Clone the git repo: https://github.com/nburuca/ako
- Launch eclipse and select open project, browse the
- From the context menu select run as Java Application or Spring Boot App (only available with Spring Suit extension)
- Goto browser and hit localhost:8080
- #5 should result in a login page
- Till we have a user profile page, use one of the following user credentials with MFA = false
- After login authentication and authorization success message should be displayed
Default users:
Username/email | password | MFA Active |
---|---|---|
[email protected] | password | true |
[email protected] | password | true |
[email protected] | password | false |
[email protected] | password | false |
[email protected] | password | true |
How to debug:
- You can use standard eclipse debug feature
- For client code, use chrome's developer tools
Working with GIT:
- You should fork the origin repo and create a branch in your forked repo.
- Make all the changes to the branch from the forked repo and commit/push changes.
- Create a pull request and issue a merge with the original repo(upstream)
Coding client:
- Create your components (refer to LoginComponent)
- Include it in index.html
- Update app.route.js
- Test if everything works
Note:
- Ideal setup environment would also include a separate client-side editor (Brackets would be my first choice, because it comes with live preview feature)
- The API also works with cross-origin requests, this can be removed when we are going live.