Skip to content

Latest commit

 

History

History
118 lines (78 loc) · 3.99 KB

README.md

File metadata and controls

118 lines (78 loc) · 3.99 KB

Welcome to Project HUB

A comprehensive platform that integrates various ai-powered tools and useful websites. It is a one-stop hub for resources such as language translator ,an image generator etc .Whether they secure have developed a new Al authentication, tool, a useful website, or enhancing any other digital project, application users can submit for approval . Once approved by the admin , the project will be added to the project section providig a platform for sharing their work with the community.

Live demo

The site is deployed through Vercel, which you can view from here

🚀 Main Features

  • Login Page
  • Data storage in MongoDB cluster
  • Approval System
  • Role-based Authentication
  • Homepage
  • Add project page
  • Contact page
  • Admin page (accessible only to admin)
  • Message page (admin only)
  • Custom Loader
  • Notifications

💻 Tech Stack

  • Nextjs
  • Typescript
  • NextAuth
  • Tailwindcss
  • MongoDB
  • Docker
  • React-Toast

🤝 Credits

Prerequisites

Required to install and run the software:

  • pnpm

If you don't have pnpm installed, you can install it by following the below steps :

Using npm

npm install -g pnpm

Alternatively you can delete the pnpm-lock.yaml file and install the dependencies with either yarn or npm

This is a Next.js project bootstrapped with create-next-app

🌟 Getting Started

create a .env file and paste the follwing content in there :

GITHUB_ID=""
GITHUB_SECRET=""
GOOGLE_ID=""
GOOGLE_SECRET=""
SECRET=""
MONGODB_URI=""
NEXT_PUBLIC_ADMIN_EMAIL=""

Now, create your own credentials for the providers and MongoDB cluster and place them in the corresponding fields ,put the email in the NEXT_PUBLIC_ADMIN_EMAIL field which you want to give admin privileges

From the project folder, run these commands in the console (terminal) to install dependencies and run the app:

npm run dev
# or
yarn dev
# or
pnpm dev

Open http://localhost:3000 with your browser to see the result.

🖼️ Some glimpse of the site

Login Page

Screenshot 2023-07-16 at 7 17 10 PM

Home Page

Screenshot 2023-07-16 at 7 20 59 PM

Add Project Page

Screenshot 2023-07-16 at 7 23 03 PM

Contact Page

Screenshot 2023-07-16 at 7 25 11 PM

Admin Page

Screenshot 2023-07-16 at 7 24 40 PM

Message Page

Screenshot 2023-07-16 at 7 27 31 PM

🐛 Bug Reporting

Feel free to open an issue on GitHub if you find any bug.

⭐ Feature Request

Feel free to Open an issue on GitHub to request any additional features you might need for your use case.

📜 License

This software is open-source, licensed under the MIT License.

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform

Check out the Next.js deployment documentation for more details.