Egglaying documentation

Introduction

Egglaying is layer-farm software: flocks, egg production and sales, feed and medicine, vaccinations, and client or supplier records (where the user’s role allows). Menus and home screens differ for admin, manager, and worker roles.

Requirements

Browser (everyone)

• Chrome, Firefox, Safari, or Edge (current versions)

Self-hosting

• Node.js 18+ (LTS recommended)
• npm or compatible package manager
• MongoDB (Atlas or self-hosted) with a connection string

Installation

1. Get the project — unzip or clone into a folder (e.g. egglaying).
2. Install dependencies

   npm install

3. Configure environment — create .env.local (see Environment).
4. Seed admin

   npm run seed:admin

   Details under Database seeds.

5. Run dev server

   npm run dev

   Open http://localhost:3000 — sign in at /auth/signin.

6. Optional sample data

   npm run seed:sample

Environment variables

Seeds read .env.local via scripts/load-env.ts. Do not commit secrets.

MONGODB_URI=mongodb+srv://USER:PASSWORD@cluster.example.mongodb.net/?appName=Cluster0
NEXTAUTH_SECRET=generate-a-long-random-string-for-production
NEXTAUTH_URL=http://localhost:3000

MONGODB_URI

Full connection string (Atlas IP allowlist + DB user).

NEXTAUTH_SECRET

Session signing secret — long random string in production.

NEXTAUTH_URL

Public site URL, e.g. https://yourdomain.com

Database seeds

Run from project root with a valid .env.local.

npm run seed:admin

Creates or updates the default admin (admin role).

• Email: admin@egg.com
• Default password: 123456 — change in production.

npm run seed:admin

npm run seed:sample

Optional demo data: users, flocks, eggs, feed, clients, etc.

npm run seed:sample

Production: rotate default passwords after first login. The live demo uses the same default password as seeds — see Live demo.

Role migration (legacy)

One-time: map legacy superadmin to admin.

npm run migrate:roles

Build & deploy

npm run build
npm run start

Set NEXTAUTH_URL to your HTTPS origin. On Vercel (and similar), copy all variables from .env.local into project settings.

Troubleshooting

• MongoDB — check URI, Atlas network access, and database user.
• Login — match seeded passwords; reset via Profile or an admin.
• Build — npm install, Node 18+.
• Session — align NEXTAUTH_SECRET and NEXTAUTH_URL with the live URL.

Getting started

Sign in at /auth/signin. Your home dashboard depends on your role. Use the sidebar for all modules; on small screens, open the menu from the header. On a fresh self-hosted install you can use the seeded admin or /auth/register when registration is enabled.

Profile (/dashboard/profile) — name, contact, password for everyone. Preferences (/dashboard/preferences) — language, currency, sidebar labels (admins).

Roles & access

Dashboard

Role-specific overview: KPIs, shortcuts, vaccine reminders, and recent activity. Everything else lives under the sidebar groups (flocks, eggs, feed, etc.).

Flocks, eggs, feed & medicine

Flocks hold schedules, health, breeds, and expenses. Eggs record production and sales. Feed and medicine track stock, purchases, and usage against your birds.

Vaccinations

Log doses and follow schedules. Due items can appear on the home dashboard.

Clients & suppliers

Available to admin and manager: contacts, commercial fields, and activity history.

Reports & profile

Analytics where your role allows. Every user can update profile and password; admins manage preferences and translation tools.

Languages

Use the sidebar language switcher (or header on mobile) for English, Bengali, or Arabic. The page may reload. Admins can open Languages to edit JSON files under messages/ (translations use next-intl).