Merge pull request 'docs: add env example and setup instructions' (#1) from vansh_code/nextplacement:docs/readme-setup into main

Reviewed-on: Arnab-Afk/nextplacement#1

README.md

@@ -1,31 +1,28 @@
-# shadcn/ui monorepo template
+# NextPlacement
 
-This template is for creating a monorepo with shadcn/ui.
+NextPlacement is a placement-management platform built as a monorepo (pnpm workspaces + Turborepo) with multiple apps and shared packages.
 
-## Usage
+## Repository Layout
+- `apps/` - application(s) (e.g., student/admin web apps)
 
+- `packages/` - reusable packages/libraries used by apps
+
+- `shared/` - sared code/assets (project-specific)
+
+- `docker-compose.yml` / `docker-compose.dev.yml` - Docker compose configurations
+
+- `DOCKER.md` - Docker notes / commands
+
+## Prerequisites
+- Git
+- Node.js (LTS recommended)
+- pnpm
+- Docker Desktop (recommended for easiest setup)
+
+## Quick Start (Docker)
+1. Create environment file:
+- Create `.env` in the project root (or copy from `.env.example` if present)
+
+2.Start containers:
 ```bash
-pnpm dlx shadcn@latest init
+docker-compose up --build
-```
-
-## Adding components
-
-To add components to your app, run the following command at the root of your `web` app:
-
-```bash
-pnpm dlx shadcn@latest add button -c apps/web
-```
-
-This will place the ui components in the `packages/ui/src/components` directory.
-
-## Tailwind
-
-Your `tailwind.config.ts` and `globals.css` are already set up to use the components from the `ui` package.
-
-## Using components
-
-To use the components in your app, import them from the `ui` package.
-
-```tsx
-import { Button } from '@workspace/ui/components/button';
-```

apps/admin/.env.example

@@ -0,0 +1,2 @@
+DATABASE_URL=postgresql://postgres:postgres@localhost:5432/nextplacement
+AUTH_SECRET=change_me

apps/student/.env.example

@@ -0,0 +1,3 @@
+ADMIN_DOMAIN=http://localhost:9001
+DATABASE_URL=postgresql://postgres:postgres@localhost:5432/nextplacement
+AUTH_SECRET=change_me