Skip to content

Commit

Permalink
[New] Add notes about development
Browse files Browse the repository at this point in the history
  • Loading branch information
blcham committed Sep 15, 2021
1 parent 01a80d4 commit 69bd986
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 2 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ The system can be split into two parts. __Main application__ provides management

## Documentation

Build configuration and deployment is described in [setup.md](doc/setup.md).
Build configuration and deployment is described in [Setup Guide](doc/setup.md).
Development is described in [Development notes](doc/development.md).

-----

Expand Down
12 changes: 12 additions & 0 deletions doc/development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Development Notes

Frontend of the application can be developed separately from the backend.
The setup requires following steps:
1) configure the application according to [Setup Guide](setup.md)
2) configure `config.properties` to contain `security.sameSite=None`
This is important if you are running the application over http so
web browser would not block requests to the server due to CORS policy.
3) build the backend `mvn clean package`
4) deploy created web application archive (`./target/record-manager-*.war`) to a web server
5) run frontend `cd ./src/main/webapp; npm run dev`
6) frontend is by default accessible from `http://localhost:3000`
2 changes: 1 addition & 1 deletion doc/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

#### Maven Profiles

To build TermIt for **non**-development deployment, use Maven and select the `production` profile.
To build the application for **non**-development deployment, use Maven and select the `production` profile.

### Application Configuration

Expand Down

0 comments on commit 69bd986

Please sign in to comment.