Creating readme, contributing, and license

CONTRIBUTING

@@ -0,0 +1,68 @@
+# Contributing to LoanManagement
+
+First off, thank you for considering contributing to LoanManagement! It's people like you that make LoanManagement such a great tool. We welcome contributions from everyone.
+
+## Getting Started
+
+- Make sure you have a [GitHub account](https://github.com/signup/free)
+- Fork the repository on GitHub
+
+## Making Changes
+
+1. Create a branch from where you want to base your work.
+
+   - This is usually the `main` branch.
+   - To quickly create a branch based on main, use:
+     `git checkout -b feature/my-contribution main`
+   - Please avoid working directly on the `main` branch.
+
+2. Make commits of logical and atomic units.
+
+3. Check for unnecessary whitespace with `git diff --check` before committing.
+
+4. Make sure your commit messages are clear and descriptive.
+
+5. Make sure you have added the necessary tests for your changes, if applicable.
+
+6. Run _all_ the tests to assure nothing else was accidentally broken.
+
+## Submitting Changes
+
+1. Push your changes to your fork of the repository.
+
+2. Submit a pull request to the main LoanManagement repository.
+
+3. The core team looks at pull requests on a regular basis and will provide feedback.
+
+## Coding Conventions
+
+- We use ESLint for maintaining code quality. Please ensure your code adheres to the project's ESLint configuration.
+
+- For ensuring proper Role-Based Access Control (RBAC), we use a `withAuth` component. All pages should be exported like this:
+
+  ```typescript
+  export default withAuth(EditApplication, ["user"]);
+  ```
+
+  The second parameter specifies the role(s) that can access the page.
+
+- Before submitting a pull request, please run `npm run build` locally to ensure there are no build errors.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
+
+2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
+
+3. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
+
+## Additional Resources
+
+- [General GitHub documentation](https://help.github.com/)
+- [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/)
+
+## Questions?
+
+If you have any questions, please feel free to contact the project maintainers.
+
+Thank you for your contributions!

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Deepesh Kumar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,36 +1,98 @@
-This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+# LoanManagement
+
+LoanManagement is a modern, secure web application designed to streamline the loan application process. Built with Next.js 14, TypeScript, and MongoDB, it offers a robust platform for users to manage loan applications, verifiers to review submissions, and administrators to oversee the entire system.
+
+![image](https://github.com/user-attachments/assets/9a97a4e2-6617-484d-85e5-f67ba703fd7e)
+
+## Features
+
+- **User Dashboard**: Create, update, delete, and track personal loan applications
+- **Verifier Tools**: Review and approve loan applications efficiently
+- **Admin Controls**: Manage users, assign roles, and oversee all applications
+- **Secure Authentication**: Powered by NextAuth for robust, flexible authentication
+- **Responsive Design**: Fully responsive UI built with Tailwind CSS, Shadcn UI and framer-motion
+
+## Tech Stack
+
+- **Frontend**: Next.js 14, TypeScript, Tailwind CSS
+- **Backend**: Next.js API Routes
+- **Database**: MongoDB
+- **Authentication**: NextAuth.js
+
+## Role-Based Access Control (RBAC)
+
+LoanManagement implements a comprehensive RBAC system:
+
+1. **Users**: CRUD operations on personal loan applications
+2. **Verifiers**: Review and approve any application
+3. **Administrators**: Full system access, user management, and global CRUD capabilities
 
 ## Getting Started
 
-First, run the development server:
+### Prerequisites
+
+- Node.js (v14 or later)
+- npm or yarn
+- MongoDB instance
+
+### Installation
+
+1. Clone the repository:
+
+   ```
+   git clone https://github.com/akadeepesh/LoanManagement.git
+   ```
+
+2. Navigate to the project directory:
+
+   ```
+   cd loan_management
+   ```
+
+3. Install dependencies:
+
+   ```
+   npm install
+   # or
+   yarn install
+   ```
+
+4. Set up environment variables:
+   Create a `.env.local` file in the root directory and add the following:
+
+   ```
+   MONGODB_URI=your_mongodb_connection_string
+   NEXTAUTH_SECRET=your_nextauth_secret
+   ```
+
+5. Run the development server:
+
+   ```
+   npm run dev
+   # or
+   yarn dev
+   ```
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
+6. Open [http://localhost:3000](http://localhost:3000) in your browser to see the application.
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+## Deployment
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+This application can be easily deployed on Vercel, the platform created by the creators of Next.js. For other deployment options, refer to the [Next.js deployment documentation](https://nextjs.org/docs/deployment).
 
-This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+## Contributing
 
-## Learn More
+We welcome contributions to LoanManagement! Please read our [CONTRIBUTING](CONTRIBUTING) file for details on our code of conduct and the process for submitting pull requests.
 
-To learn more about Next.js, take a look at the following resources:
+## License
 
-- [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.
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+## Acknowledgments
 
-## Deploy on Vercel
+- Next.js team for the amazing framework
+- Vercel for the seamless deployment platform
+- MongoDB team for the powerful database solution
 
-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.
+---
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
+For support or queries, please open an issue or contact me at [email protected].