nest-gmaps-api

Simple Google Maps API Proxy Server.

Table Of Contents

• Developer Section
  • Requirements
  • Dependencies
  • Setup
  • API Documentation
  • Project Structures
  • Git Conventions

Developer Section

Requirements

• Install Node.js with the same version as defined on package.json engines or .nvmrc file.

  You may use NVM (Node Version Manager) for easy installation.

  nvm use

Dependencies

Main packages that are used as foundation for this project.

• NestJS -- framework for building efficient, scalable Node.js server-side applications.
• Axios -- Promise based HTTP client for the browser/node.js.

Setup

1. Install dependencies

   npm install

2. Intialize git hooks to validate commit messages

   npx simple-git-hooks

3. Create .env file. Use .env.example as a template.

4. Now you're good to go!

   npm run start:dev

API Documentation

• Google Maps API Docs.

Project Structures

This project is follow the Clean Architecture principles.

• /src -- Source code

  • main.ts -- Application entry point.

  • /domain -- Domain layer (Entities and services abstractions).

  • /infrastructures -- Infrastructure layer (Services implementations).

  • /interfaces -- Interfaces layer (Application routes/controllers).

  • /use_cases -- Application logic layer.

  • **/libs -- Common constants, or other utilities used by folder it belongs, e.g /src/libs is global libs, /src/domain/libs is domain libs, and so on.

Git Conventions

We use Conventional Commits to handle Git commit messages, and Github PR titles.

Look at gitlint.config.ts to see supported commit types/scopes.

Issue Title

<type>(<scopes(optional)>): <content>

Examples:

• feat: Geocoding API
• feat: Places API

Commit Message / PR Title

<type>(<scopes(optional)>): <content> gm-<issue-number>

Examples:

• feat: init swagger gm-4
• feat(src-use_cases): add geocode use cases gm-4

Branch Name

<type>-<content>-gm-<issue-number>

Examples:

• feat-geocoding-gm-4