[Docs] [Done] [Bishwajeet] update README.md to enhance project description, features, and setup instructions

Author: SahooBishwajeet

langsuit/README.md

@@ -1,36 +1,142 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# LangSuit 🌍
+
+An easy way to become a Polyglot - A modern language learning platform built with Next.js.
+
+## Features
+
+- 🎯 Interactive language learning exercises
+- 📊 Real-time progress tracking
+- 🏆 Leaderboard and achievements system
+- 🎓 Multiple language courses
+- 💻 Instructor dashboard
+- 📱 Mobile-responsive design
+- 🔄 Real-time analytics
+
+## Tech Stack
+
+- Next.js 14 with App Router
+- TypeScript
+- Drizzle ORM with PostgreSQL
+- Redis Caching
+- TailwindCSS
+- Clerk Authentication
+- React Admin Dashboard
+- Recharts for Analytics
+- Jest for Testing
+
+## Prerequisites
+
+- Node.js 18+
+- PostgreSQL
+- Redis (optional, for caching)
 
 ## Getting Started
 
-First, run the development server:
+1. Clone the repository:
+
+```bash
+git clone https://github.com/codegasms/langsuit.git
+cd langsuit
+```
+
+2. Install dependencies:
+
+```bash
+npm install
+```
+
+3. Set up environment variables:
+
+```bash
+cp .env.example .env
+```
+
+4. Update the .env file with your credentials:
+
+```env
+DATABASE_URL=your_postgres_url
+REDIS_URL=your_redis_url
+CLERK_SECRET_KEY=your_clerk_key
+.
+.
+.
+```
+
+5. Run database migrations:
+
+```bash
+npm run db:push
+```
+
+6. Seed the database:
+
+```bash
+npm run db:seed
+```
+
+7. Start the development server:
 
 ```bash
 npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+Open [http://localhost:3000](http://localhost:3000) to see the application.
+
+## Available Scripts
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+- `npm run dev` - Start development server
+- `npm run build` - Build for production
+- `npm run start` - Start production server
+- `npm run lint` - Run ESLint
+- `npm run format` - Format code with Prettier
+- `npm run test` - Run tests
+- `npm run test:coverage` - Run tests with coverage
+- `npm run db:studio` - Open Drizzle Studio
+- `npm run db:push` - Push database changes
+- `npm run db:seed` - Seed the database
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+## Testing
 
-## Learn More
+The project uses Jest for testing. Run the test suite with:
+
+```bash
+npm run test
+```
+
+For coverage report:
+
+```bash
+npm run test:coverage
+```
+
+Check [package.json](package.json) for more scripts.
+
+## Project Structure
+
+```
+langsuit/
+├── app/                    # Next.js app directory
+│   ├── (dashboard)/       # Dashboard routes
+│   ├── (home)/           # Public routes
+│   └── api/              # API routes
+├── components/            # Reusable components
+├── db/                    # Database configuration
+├── lib/                   # Utility functions
+├── public/               # Static assets
+└── tests/                # Test files
+```
 
-To learn more about Next.js, take a look at the following resources:
+## Contributing
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+1. Fork the repository
+2. Create a new branch
+3. Make your changes
+4. Submit a pull request
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+## License
 
-## Deploy on Vercel
+This project is licensed under the MIT License.
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+## Support
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+For support, email bishwajeet.s22@iiits.in, parth.v22@iiits.in or akshat.m22@iiits.in. Otherwise open an issue in the repository.