Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README #4

Merged
merged 1 commit into from
Nov 29, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 80 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ In the context of ITS, an Operational Data Environment is a real-time data acqui
### Source Repository - GitHub
https://github.com/usdot-jpo-ode/jpo-ode

### Agile Project Management - Jira
https://usdot-jpo-ode.atlassian.net/
### Agile Project Management - Taiga
https://tree.taiga.io/project/toryb-its_jpo_ode_agile/

### Wiki - Confluence
https://usdot-jpo-ode.atlassian.net/
### Wiki - Taiga
https://tree.taiga.io/project/toryb-its_jpo_ode_agile/wiki/home

### Continuous Integration and Delivery
https://travis-ci.org/usdot-jpo-ode/jpo-ode
Expand All @@ -26,11 +26,85 @@ https://travis-ci.org/usdot-jpo-ode/jpo-ode

### Local Build

###### Dependencies

You will need the following dependencies to run the application:

* Maven: [https://maven.apache.org/install.html](https://maven.apache.org/install.html)

IDE of your choice:

* IntelliJ: [https://www.jetbrains.com/idea/](https://www.jetbrains.com/idea/)
* STS: [https://spring.io/tools/sts/all](https://spring.io/tools/sts/all)
* Eclipse: [https://eclipse.org/](https://eclipse.org/)

Private Jars:

* ASN.1 BSM Encoder/Decoder: To receive the private jar, please contact the development team.


#### Clone the Repo

Please request access if needed, but with a git client or the command line, you can clone repo.

`git clone https://github.com/usdot-jpo-ode/jpo-ode.git`

#### Building and Running the project

To build the project using maven command line:

Navigate to the root directory

`cd jpo-ode/`

Build the project, downloading all of the JAR needed and compiling the code

`mvn clean install`


Navigate to the project folder supporting the service

`cd /jpo-ode-svcs`

Run the script to establish a local Spring instance

`sh run.sh`

You should be able to access the running service at `localhost:8080`, but submissions will not work without the ASN.1 Jar installed locally.

Once you have a jar installed with the project, you should be able to upload the following file and test for a successful output.

```
{
"coreData": {
"position": {
"latitude":42.3288028,
"longitude":-83.048916,
"elevation":157.5
}
}
}
```

And the output:

```
2016-11-29 10:52:13.793 INFO 6449 --- [nio-8080-exec-2] u.d.i.j.o.s.FileSystemStorageService : AExMjM0AAFrSdJU1pOjWCE6AAAAAAAUAAH59B9B/f/8AAAUAUAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA==

2016-11-29 10:52:13.794 INFO 6449 --- [nio-8080-exec-2] u.d.i.j.o.s.FileSystemStorageService : Latitude: 0.0000042

2016-11-29 10:52:13.794 INFO 6449 --- [nio-8080-exec-2] u.d.i.j.o.s.FileSystemStorageService : Longitude: -0.0000083

2016-11-29 10:52:13.795 INFO 6449 --- [nio-8080-exec-2] u.d.i.j.o.s.FileSystemStorageService : Elevation: 15.7
```

Which demonstrates a loop of Readable JSON -> ASN.1 UPER encoded BSM Message -> Readable Output



### Continuous Integration and Delivery

### Deployment

## Docker
docker/README.md