Mini Project Manager

A platform for college students and teachers to manage semester mini project courses
Explore the docs »

Live Preview · Report Bug

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

The "Mini Project Manager" is a platform designed for college students and teachers to manage semester mini project courses. Students can create teams and invite their batch mates to collaborate on projects under the guidance of a mentor. The platform facilitates team creation, batch mate invitations, mentor assignments, and communication.

Built With

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Before you begin, ensure you have the following prerequisites:

• PostgreSQL Database: If you don't have PostgreSQL installed locally, you can either install it or use a cloud service like Supabase. If you choose to install PostgreSQL locally, you can download it from the official website.
• Google Project: You'll need to create a project on Google Console to enable Google login functionality. Follow these steps to create a new project:
  1. Go to Google Cloud Console.
  2. Click on "Select a project" dropdown at the top of the page and then click on "New Project".
  3. Enter a project name, select your organization (if applicable), and click "Create".
  4. Once the project is created, navigate to "API & Services" > "Credentials" to obtain your Client ID and Client Secret for Google authentication.
• Resend Account: You'll also need to create an account on Resend to obtain an API key. Visit Resend and sign up for an account.

Installation

1. Clone the repo

   git clone https://github.com/YaSh8202/miniproject-manager

2. Install NPM packages

   pnpm install

3. Create a .env file in the root directory and paste the contents of .env.example into it:

   cp .env.example .env

4. Configure the following environment variables in your .env file:

   • DATABASE_URL: Provide the URL for your PostgreSQL database. If you're using a local database, the URL will typically be postgres://:@localhost:/<database_name>.
   • NEXTAUTH_SECRET: Generate a secure secret key using the following command:

     openssl rand -base64 32

   • GOOGLE_CLIENT_ID: Use the Client ID obtained from your Google project.
   • GOOGLE_CLIENT_SECRET: Use the Client Secret obtained from your Google project.
   • RESEND_API_KEY: Use the API key obtained from your Resend account.

5. Once you've completed these steps, your environment should be set up and you can run the project locally using the following command:

   pnpm dev

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Acknowledgments

• Shadcn/ui
• Tailwind Css
• Vercel
• Supabase
• Icones