PROJECT CATALOG 📚

Welcome to PROJECT CATALOG, a platform where students can refer to past projects added by admins/co-ordinators.

• Next.js 🚀
• NextAuth.js 🔒
• Mantine UI 🎨
• Google Analytics 📈
• MongoDB 🍃
• Deployed on Vercel 🌐

User Roles and Permissions 👥

1. Simple User 👤

   • Can only view projects.
   • A new user is always a simple user

2. Co-ordinator 🛠️

   • Can add a project.
   • Can view projects.
   • Username : [email protected]
   • Password : 10

3. Admin 👑

   • Can add projects.
   • Can view projects.
   • Can promote/demote a user or co-ordinator.
   • Username : [email protected]
   • Password : 1

Live Deployment 🌍

The web app is currently live and can be accessed here.

Installation and Setup 🚀

To get started with the project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/neeramrutia/nextjs_project_manager.git

2. Navigate to the project directory:

   cd project-catalog

3. Install dependencies:

   npm install

4. Set up env file

   Create a .env.local file in the root of the project and add the necessary environment variables. Refer to .env.example for guidance.

5. Run dev server

   npm run dev
   

Technologies Used 🛠️

• Next.js: The React framework for production.
• NextAuth.js: Authentication for Next.js applications.
• Mantine UI: A fully featured React components library.
• Google Analytics: For tracking and reporting website traffic.
• MongoDB: A NoSQL database for storing project data.
• Vercel: Deployment platform for frontend frameworks and static sites.

Contributing 🤝

We welcome contributions! Please open an issue or submit a pull request.

Steps to Add Your Project 📝

Follow these steps to add your project to the PROJECT CATALOG:

1. Clone the repository:

   git clone https://github.com/neeramrutia/nextjs_project_manager.git
   

2. Update the Add_your_project.json file:

   Fill in the required details about your project in the Add_your_project.json file (Add project info as a JSON object in the projects Array). Include the following information:

   • Project Name
   • Max 5 Screenshots (add to Screen-shots folder)
   • Description
   • Names of Members Contributed in Your Project
   • Tech Stack Used (Max 5)
   • Short 2 Min Video Explaining Your Project (Optional) (Add a folder(name should be same as projects name) containing the video to VIDEOS folder)
   • Mentor's Name (Optional)
   • Readme (Add a folder to the README Folder containing th readme file)
   • Github Link
   • Deployed project link(optional)

3. Submit a pull request:

   Submit a pull request with your updated Add_your_project.jsson file. Wait for your request to be merged, and your project will be added to the list of all projects.

License 📜

This project is licensed under the MIT License.

---

Happy coding! 💻✨