README.md

Nusaventure Backend

Nusaventure REST API is a web service that provides access to a large collection of data on places to travel around the archipelago. It allows users to search for places, retrieve place details, and perform various operations related to tourist attractions, restaurants, etc.

Tech Stack

• Hono over Bun runtime
• Typescript
• Prisma ORM
• PostgreSQL
• Render
• Neon

API Specification

The OpenAPI Specification for the Nusaventure API offers a detailed description of the API's services. It can be accessed at the path /api-spec.

For a more interactive experience, you can use SwaggerUI. It provides a user-friendly interface for exploring and testing the API. You can access SwaggerUI at /ui.

You can also access the following:

• OpenAPI Specification: https://api.nusaventure.com/api-spec
• SwaggerUI: https://api.nusaventure.com/ui

Database Design

To view the latest database design in more detail, you can navigate to the following link: ERD

Getting Started

Set up .env by copying from .env.example for reference

cp .env.example .env

Install dependencies

bun install

Run DB migration

bun run migrate:dev

Then you can run

bun run dev

Afterwards, open your browser and navigate to http://localhost:3000 to start exploring the API.