Sure! Here's a detailed README.md you can use for your WarTech 3.0 project, including setup, installation, and usage instructions for both frontend and backend:
A full-stack web application for event registration, handling team submissions, and integrating Razorpay payments. Built with React.js for frontend, Node.js/Express for backend, and MongoDB for database.
- Event registration form with team details
- Multiple team members support
- Razorpay payment integration
- Payment verification & status tracking
- Completed payments stored separately
- Responsive UI built with React
- Frontend: React.js
- Backend: Node.js, Express.js
- Database: MongoDB (Mongoose ODM)
- Payments: Razorpay
- Environment Variables: dotenv
WartechFull/
├── backend/
│ ├── controllers/
│ ├── models/
│ ├── routes/
│ ├── config/
│ ├── index.js
│ └── package.json
├── frontend/
│ ├── src/
│ │ ├── components/
│ │ ├── pages/
│ │ ├── App.js
│ │ └── index.js
│ └── package.json
└── README.md
- Node.js (v18+ recommended)
- npm or yarn
- MongoDB Atlas account or local MongoDB
- Razorpay account (test keys work)
git clone https://github.com/Uncle8475/WartechFull.git
cd WartechFullcd backend
npm installCreate a .env file in backend/:
PORT=5000
MONGO_URI=your_mongodb_connection_string
RAZORPAY_KEY_ID=your_razorpay_key_id
RAZORPAY_KEY_SECRET=your_razorpay_key_secretnpm run devServer will run at http://localhost:5000
cd frontend
npm installCreate a .env file in frontend/:
REACT_APP_API_BASE_URL=http://localhost:5000/api
REACT_APP_RAZORPAY_KEY_ID=your_razorpay_key_idnpm startFrontend will run at http://localhost:3000
- Open the app in your browser:
http://localhost:3000 - Select the event type, team name, and add team members
- Click Proceed to Pay to open Razorpay checkout
- Complete the payment
- Payment will be verified automatically and added to completed payments
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/form/create |
Create new form + Razorpay order |
| POST | /api/payment/verify |
Verify Razorpay payment |
| GET | /api/payments/completed |
Get all completed payments |
- User submits form → backend creates a Razorpay order
- Razorpay checkout opens → user pays
- Backend verifies payment signature
- Successful payment → added to
CompletedPaymentscollection, deleted fromFormandPayment
- Fork the repository
- Create a new branch (
git checkout -b feature/your-feature) - Make your changes
- Commit (
git commit -m 'Add some feature') - Push (
git push origin feature/your-feature) - Open a Pull Request
This project is licensed under the MIT License.
If you want, I can also write a prettier version with badges, screenshots, and full Razorpay instructions, so your GitHub repo looks professional.
Do you want me to do that next?