Funne API

Documentation

Environment Variabels

For using this API, you need to create .env file in root directory of this project. You can copy the .env.example file and rename it to .env. Then, you can fill the environment variables with your own values.

Detail of environment variables can be found in .env.example file.

Scripts

The following scripts are available:

Script	Description
pnpm start	Run the server
pnpm start:prod	Run database migration for production and run the server
pnpm db:migrate	Create database migration for development
pnpm db:studio	Run prisma studio (GUI Database explorer)
pnpm db:generate	Generate artifacts for prisma client
pnpm format	Run code formating with prettier

Google Service Authentication

For some features using google APIs like google vision api should be authenticated first.

• Local Development with ADC
• On Google Cloud environment it will using service account.

Development Guide

For better development experience, the following VSCode extensions are recommended:

• ESLint (Code Linter)
• Prettier (Code Formatter)
• Prisma (Syntax support for Prisma Schema)

Contributors

• C243DSX0644 - Edwin Tantawi
• C350DSY3018 - Puan Abidah Nitisara