Skip to content

NgocLe-101/flowora-api

Repository files navigation

Flowora API

This folder contains the Flowora backend, built with NestJS (TypeScript). It implements the REST API used by the frontend.

Quick start

  1. Install dependencies
   cd flowora-api
   npm install
  1. Prepare environment

    • Copy or create an .env file in flowora-api/ if you need to provide configuration values.
  2. Run in development mode (with hot reload)

   npm run start:dev

   Default: http://localhost:3000

Docker (optional)

You can run the API using Docker Compose (there is a docker-compose.yml in this folder):

   docker-compose up --build

Scripts

  • npm run start — start production server
  • npm run start:dev — start dev server (watch mode)
  • npm run start:prod — start production build
  • npm run test — run unit tests (if present)
  • npm run test:e2e — run end-to-end tests (if present)

Notes

  • Port: the Nest app typically listens on port 3000; check src/main.ts if you need to change it.
  • Environment variables: sensitive values belong in .env and should not be committed to git.

If you want, I can add a minimal .env.example here and a few example API curl commands for core endpoints.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors