Transect Explorer

Prerequisites

• Node.js
• npm
• Android Studio
• Docker

Installation

1. Clone the repository to your local machine:

   git clone git@github.com:A-dith-ya/transect-explorer.git

2. Install the dependencies for the app:

   cd app/
   npm install

3. Run the app:

   npm run dev

4. Rebuild docker images after making changes to code:

   docker compose build

5. Run the server on port 8080, postgres on port 5432:

   docker compose up

6. Stop the server and postgres:

   docker compose down

Building and Running the Android App

1. Install the dependencies for the app:

   cd app/
   npm install

2. Build the app:

   npm run build

3. Sync the app:

   npx cap sync

4. Open app on Android Studio and run it:

   npx cap open android

API Documentation

The API documentation is generated using the OpenAPI Specification and is accessible at Swagger UI.