Development Setup Guide

Frontend (Vue.js)

The frontend is built using Vue 3, Vite, Bootstrap, and Node v18.2.1.

Development Environment Setup:

1. Navigate to the frontend folder.

2. Run the following commands in your terminal:

npm install
npm run dev

3. Access the frontend at http://localhost:80.

For detailed frontend documentation, please visit: Frontend Documentation.

Backend (Node.js)

The backend is configured to run on the Express framework, with support for Prisma ORM, MariaDB (SQL), and Redis for cache management. While MariaDB, Prisma, and Redis are commented out by default, you can enable them according to your needs.

Prerequisites for Fully Functional Backend:

1. Install MariaDB in a Docker container on your local machine (Port 3306).

2. Install Redis server in a Docker container on your local machine (Port 6379).

Note: You're free to use your preferred database (DB) and backend strategy.

Setting Up the Backend:

1. Navigate to the backend folder.

2. Run the following command in your terminal:

npm install

If you've enabled MariaDB and Prisma:

npx prisma db push  # Sync prisma schema with the database.

For Prisma, schema generation was already completed during the npm install procedure as a postinstall script.

Starting the Backend:

1. After ensuring your backend is properly configured with or without MariaDB, Prisma, or Redis, run:

npm run dev

2. Access the backend at http://localhost:9000.

For in-depth backend setup and documentation, refer to: Backend Documentation.