Quick Start

Get your Lab Equipment Management System up and running in just a few minutes.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v18 or higher)
• npm or yarn
• Docker and Docker Compose
• Git

1. Clone the Repositories

# Clone backend repository
git clone https://github.com/knightempire/lab-backend.git
cd lab-backend

# Clone frontend repository (in a new terminal)
git clone https://github.com/knightempire/lab-frontend.git
cd lab-frontend

2. Environment Setup

Backend Configuration

Create a .env file in the backend directory:

# Database Configuration
DB_HOST=localhost
DB_PORT=27017
DB_NAME=lems_db

# JWT Configuration
JWT_SECRET=your-super-secret-jwt-key
JWT_EXPIRE=7d

# PASETO Configuration
PASETO_SECRET=your-paseto-secret-key

# Email Configuration
EMAIL_HOST=smtp.gmail.com
EMAIL_PORT=587
EMAIL_USER=your-email@gmail.com
EMAIL_PASS=your-app-password

# Server Configuration
PORT=5000
NODE_ENV=development

Frontend Configuration

Create a .env.local file in the frontend directory:

# API Configuration
NEXT_PUBLIC_API_URL=http://localhost:5000/api
NEXT_PUBLIC_SOCKET_URL=http://localhost:5000

# App Configuration
NEXT_PUBLIC_APP_NAME=Lab Equipment Management System
NEXT_PUBLIC_APP_VERSION=1.0.0

3. Docker Setup (Recommended)

Option A: Using Docker Compose

# Backend
cd lab-backend
docker-compose up --build

# Frontend (in a new terminal)
cd lab-frontend
docker-compose up --build

Option B: Manual Setup

Option B: Manual Setup

# Backend
cd lab-backend
npm install
npm run dev

# Frontend (in a new terminal)
cd lab-frontend
npm install
npm run dev

4. Access the Application

Once both services are running:

• Frontend: http://localhost:3000
• Backend API: http://localhost:5000
• API Documentation: http://localhost:5000/api-docs

5. Default Login Credentials

🔐 Default Admin Account

• Email: admin@lems.com
• Password: admin123

👤 Default User Account

• Email: user@lems.com
• Password: user123

6. Verify Installation

Test the installation by:

1. Login: Use the default credentials to log in
2. Dashboard: Check that the dashboard loads correctly
3. API: Visit the API endpoints to ensure they're working
4. Database: Verify that data is being stored correctly

Troubleshooting

Common Issues

7. Troubleshooting

❌ Port Already in Use

If ports 3000 or 5000 are already in use, you can change them:

• Backend: Change PORT in .env
• Frontend: Use npm run dev -- -p 3001

❌ Database Connection Failed

Ensure MongoDB is running:

• Docker: docker run -d -p 27017:27017 mongo
• Local: Start MongoDB service

❌ Module Not Found

Clear node_modules and reinstall:

rm -rf node_modules package-lock.json
npm install

Next Steps

• Configuration Guide - Detailed configuration options
• User Guide - Learn about user roles and permissions
• API Reference - Explore the API endpoints
• Development Guide - Start developing with LEMS

Need Help?

• Check the FAQ
• Browse the API Documentation
• Contact the team lead: Abinesh
• Open an issue on GitHub