Overview

The Peninsular API is a crucial component of the Peninsular application ecosystem, primarily serving the application UI and integrating with Google Sheets through Google Apps Script. This API is built using NestJS, Swagger, PostgreSQL, TypeORM, and other complementary technologies.

Features

• Integration with Application UI: Provides endpoints to facilitate communication between the Peninsular application frontend, Google Sheet and backend.
• Google Sheets Integration: Seamlessly integrates with Google Sheets using Google Apps Script, enabling data synchronization.
• Built with NestJS: Leveraging the robustness and scalability of NestJS framework for building efficient and maintainable APIs.
• Swagger Documentation: Utilizes Swagger for clear and interactive API documentation, ensuring ease of use for developers.

Google Sheet Functionality

Demo for functions including filter/search and api call inside cell.

Development

# 1. Create Environment variables file.
cp .env.example .env

# 2. Install dependencies. (Make sure yarn is installed: https://yarnpkg.com/lang/en/docs/install)
yarn

# 3. Start container
docker compose up -d

# 4. Run database migration
yarn migration:run

# 5. Seed database
yarn seed

# 6. Run development server and open http://localhost:3000
yarn watch:dev

Build

To build the App, run

yarn build:prod

And you will see the generated file in dist that ready to be served.