VeSync

VeSync is a full-stack application. It consists of a Node.js/Express backend and a React/Vite frontend. The entire application is containerized using Docker and Docker Compose for easy setup and local development.

Prerequisites

Before you begin, ensure you have the following installed on your machine:

• Git
• Docker
• Docker Compose

Quick Start (Docker)

To run the entire application locally with a single command, follow these steps:

1. Clone the repository

git clone <your-repository-url>
cd VeSync-Docker

2. Set up Environment Variables

Since sensitive configurations are not tracked in Git, you need to set up your environment variables for the backend.

1. Navigate to the backend folder:

   cd VeSync-BackEnd

2. Create a .env file based on the required configuration. It should look something like this:

   PORT=7777
   MONGODB_URI=<your-mongodb-connection-string>
   JWT_SECRET=<your-secret-key>
   # Add any other required backend variables here

3. Return to the root folder:

   cd ..

3. Start the Application

Once your .env file is ready, you can start the complete application using Docker Compose:

docker compose up --build

(Optional: Add -d at the end to run it in detached mode in the background).

4. Access the Application

• Frontend: http://localhost:5173
• Backend API: http://localhost:7777

Development

The Docker setup uses volume mapping, meaning any changes you make to the code in the VeSync-BackEnd or VeSync-FrontEnd folders on your host machine will instantly reflect inside the containers (hot-reloading).

• Backend: Uses nodemon for hot-reloading.
• Frontend: Uses Vite's native dev server for fast HMR (Hot Module Replacement).