bcgov / citz-imb-wayfinder

CITZ IMB Capstone 2023 Wayfinder

Apache License 2.0

6 stars 2 forks source link

Wayfinder init remove tsoa #16

Closed LocalNewsTV closed 1 year ago

LocalNewsTV commented 1 year ago

Description

This PR includes the following proposed change(s):

Removed TSOA due to dependency on running builds to operate, conflicting with the dev environment with docker
Converted all TSOA usage into regular express / typescript syntax
Implemented Swagger documentation in Yaml, as it it will no longer be automatically generated
updated package.json to reflect testing and removal
This PR Will make future development of the API feasible

Type of change

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[x] Refactoring / Documentation
[x] Updating Testing Framework(s)
[ ] Version change

How Has This Been Tested?

Manual testing of end point
Using the Swagger documentation to test end point
Started implementing Jest testing, which passed.

Frontend Development Changes

[x] N/A
[ ] I have performed a self-review of my own code
[ ] I have made corresponding changes to project documentation or diagrams that reflect my changes
[ ] New and existing unit tests pass locally with my changes
[ ] My code follows Airbnb React Style Guidelines

API Development Changes

[ ] N/A
[x] I have performed a self-review of my own code
[ ] My code follows standards and practices outlined in the BC Government API Development Guidelines
[x] New and existing unit tests pass locally with my changes
[x] My changes includes Swagger documentation updates that reflect the changes I am introducing

I...

[x] checked my files for crlf issues
[x] confirmed the existing Dockerfile still works with no modification