- Spring Boot used at API end
- Angular 8 used at Front end
- Derby DB to store planet data
- Hibernate used as ORM tool
- Spring Security used with basic auth for now. Basic Auth added for now with a fixed user credentials. Credentials can be found in application.properties.
- JUnit used for unit testing at API end.
- Front end codebase kept separate for maintaining separation of concerns and better management of code.
- Nebular used as a front end theme for UI implementation.
- CORS enabled at API end in Spring security to facilitate API calling from front end. Allowed domains setup from application.properties.
- Shortest path algorithm is written as an independent utility which is agnostic of node entity types. It's completely based on Vertex, Edge and Graph POJO classes. This allows reusability of same algorithm to any other entity than Planets in future .
- An adapter service created which works on converting Planet/Route to Vertex/Edge.
- Login feature added both at front end and back end. A simple login API returning basic auth token after successful verification.
- Data setup done using excel upload feature. File uploaded from front end and stored/parsed at backend to seed data into DB.
- Both REST as well as SOAP API created to get shortest path between planets.
- Every new Excel upload will mean a new data seed and any old data will be cleard.
- Route has a foreign key mapping with Planet for source and destination columns. So, any Route with a Planet which is not there in Planet table will be ignored while data seed from file.
- DELETE and PUT operations for Planets are not required from front end.
- Creation of data only happens via the Excel upload.
- REST and SOAP apis are both accepting Planet names as source and destination parameters instead of Planet nodes. This was done purposely for making it easier for me to visually see the data. If these APIs are consumed by another system, we can easily switch from planet names to planet nodes.
- Better Exception handling
- Better unit test case coverage
- Basic Auth should be replaced with OAuth + JWT strategy
- Improve Swagger documentation and / or add java docs
- Implement 7th point - [Optional: Overlay the following data and re-compute] from original assignment
- Dockerize the backend and frontend? Depends upon deployment strategy
- Delete Excel files from the server onces Excel uploading is complete
Refer here.
Refer here.