Pulse

An alert and monitoring system.

---

Prerequisites

• Docker (if you want to run with Docker)
• Node.js and npm (if you want to run locally without Docker)

---

Setup

1. Modify .env files

You need to configure environment variables separately for frontend and backend:

• pulse/frontend/.env.example
• pulse/backend/.env.example

---

2. Running with Docker Compose (recommended)

From the root pulse directory (where docker-compose.yml is):

docker compose up -d --build

This will build and start both frontend and backend containers with your configured .env files.

---

3. Running without Docker

You can run frontend and backend separately if you don’t want to use Docker.

• Open one terminal, go to backend:

  cd pulse/backend
  npm install
  npm run dev

• Open another terminal, go to frontend:

  cd pulse/frontend
  npm install
  npm run dev

Make sure both frontend and backend .env files are properly configured before running.

---

Usage

Once the app is running, open your browser and visit:

http://localhost:3000

Here you can signup and then sign in to start using the application.

---

Notes

• The backend server usually runs on port 4000 (or your configured port)
• The frontend server runs on port 3000
• Make sure these ports are free on your machine

---

Troubleshooting

• If you change .env files, rebuild the Docker images (docker compose build) before restarting.
• If you get errors with missing dependencies, run npm install again inside the relevant folder.