Issue: 138 | Migrated project JS architecture to NestJS

[Abhinav-Saxena-dev]

#138

Description

• Migrated the vanilla js architecture of the project to Nest js architecture, utilizing its benefits.

Project Structure

- src
  - app
    - models
      - city
        - city.controller.ts
        - city.module.ts
        - city.controller.spec.ts
        - city.service.ts
        - city.service.spec.ts
      - georev
        - georev.controller.ts
        - georev.module.ts
        - georev.serializer.ts
        - georev.controller.spec.ts
        - georev.service.ts
        - georev.service.spec.ts
      - location
        - location.controller.ts
        - location.module.ts
        - location.serializer.ts
        - location.controller.spec.ts
        - location.service.ts
        - location.service.spec.ts
  - config
    - config.ts
    - env
        - default.env
  - geojson-data
  - Scripts
    - gdb_to_geojson
    - parse.geojson
  - services
    - geojson
        - geojson.service.ts
        - geojson.service.spec.ts
    - geoquery
        - geoquery.service.ts
        - geoquery.service.spec.ts
  - util
    - serializer
      - success
      - error

• Each module handles its respective endpoint.
• GeoJson and GeoQuery services each contain common service functions having a single responsibility.
• Formatting functions have been further classified as per their response status, if it's a success or an error. The serializer directory of utils contains these individual serializers.

Testing Screenshots

1. /city/{ip}

cURL: curl --location --request GET 'http://localhost:3000/city/2401:4900:1c82:377e:bb89:dfc9:28a1:1e06'

2. /city/batch

cURL: curl --location --request POST 'http://localhost:3000/city/batch' \ --header 'Content-Type: application/json' \ --data-raw '{ "ips": ["128.101.101.101", "2401:4900:1c82:377e:bb89:dfc9:28a1:1e06"] }'

3. /georev

cURL: curl --location --request GET 'http://localhost:3000/georev?lat=28.7041&lon=77.1025 ' \ --header 'Content-Type: application/json' \ --data-raw '{ "ips": ["128.101.101.101", "2401:4900:1c82:377e:bb89:dfc9:28a1:1e06"] }'

4. /location/{locationlevel}/centroid

cURL: curl --location --request GET 'http://localhost:3000/location/DISTRICT/centroid?query=lucknow'

5. /location/{locationlevel}/fuzzysearch

cURL: curl --location --request POST 'http://localhost:3000/location/VILLAGE/fuzzysearch' \ --header 'Content-Type: application/json' \ --data-raw '{ "query": "Arong", "filter": { "STATE": "Andaman & Nicobar Islands", "DISTRICT": "Nicobars" } }'

Tasks / Sequence of task completion

• Setup structure of project
• Configure project settings.
• Identity and create modules
• Classify each API endpoint and migrate code to respective modules.
• Create common services
• Implement utility files and functions.
• Migrate script for initial setup.
• Configure Swagger documentation.
• Clean up logger usage
• Code Clean up / Separate controller and business logic
• Remove unnecessary boilerplate files.
• Write test cases
• Setup project documentation

[ChakshuGautam]

Hey @Abhinav-Saxena-dev this is brilliant!!!

Give me a couple of days to review this. I was swamped earlier. Will start reviewing today onwards.

[ChakshuGautam]

Let's make these change first before I review this further.

[ChakshuGautam]

Tests need to be migrated too.

[Abhinav-Saxena-dev]

Test cases have been updated