This project is copyrighted by dev-adalz and nebucoders (2025). All rights reserved. No part of this project may be reproduced, distributed, or transmitted in any form or by any means, without the prior written permission of the copyright holder, except for viewing and forking on GitHub.
A web application for PIMUN ’25, built using Next.js, React Hooks, and the Next.js router.
This repository contains the client (frontend) and server (backend) code, along with shared utilities.
You can view the live deployment here:
pimun25.vercel.app
- Frontend / Client: Next.js, React, React Hooks, Tailwind CSS
- Backend / Server: (if exists — e.g. Node.js / Next API routes / custom server)
- Styling: Tailwind CSS
- Build / Bundler: Vite or Next.js internal build
- TypeScript throughout
- Multi-page navigation via Next.js Router
- Reactive components built with React Hooks
- Shared utilities & types in
shared/ - Backend API routes (if applicable)
- Integration with database using Drizzle ORM
- Responsive design with Tailwind CSS
/
├── client/ # Next.js frontend
├── server/ # Backend server / API routes (if separate)
├── shared/ # Shared types, utilities
├── docs/ # Documentation
├── design_guidelines.md # UI / design guidelines
├── drizzle.config.ts # Drizzle ORM config
├── tailwind.config.ts # Tailwind CSS config
├── tsconfig.json
├── package.json
├── vercel.json
└── …
Here’s a brief description of core directories:
- client/: frontend application
- server/: backend / API logic
- shared/: types, interfaces, helper functions used by both client & server
- docs/: project documentation
- design_guidelines.md: design system, UI guidelines
- Other config and root files for build, routing, environment, etc.
- Node.js (>= 18 recommended)
- npm or yarn
- (If using a database) credentials / access to your database instance
-
Clone the repository
git clone https://github.com/dev-adalz/pimun25.git cd pimun25 -
Install dependencies
npm install # or yarn install
Adjust according to how your backend / frontend are configured.
Run both client & server (if separate) or the Next.js app:
npm run devThen open http://localhost:5000 in your browser.
Here are some important npm scripts you may have or want to include:
| Script | Description |
|---|---|
dev |
Run in development mode with hot reloading |
build |
Build the production version |
start |
Start the production server |
lint |
Run linter / code checks |
format |
Format code (e.g. with Prettier) |
db:migrate |
Run database migrations (if applicable) |
You can check package.json for the complete list.
This project is deployable to Vercel (or other hosting platforms).
Ensure environment variables are set appropriately in the deployment environment.
If using a serverless / API route model, you may not need a separate server.
Contributions, bug reports, feature requests, etc. are welcome!
Please follow these steps:
- Fork the repository
- Create a feature branch:
git checkout -b feature/YourFeature - Make your changes
- Test thoroughly
- Submit a Pull Request
You can also open issues to discuss ideas or propose changes.
Project maintained by dev-adalz with ❤️.
Feel free to reach out via GitHub or email (adalzuhair.info@gmail.com).