Skip to content

Latest commit

 

History

History
76 lines (57 loc) · 2.27 KB

README.md

File metadata and controls

76 lines (57 loc) · 2.27 KB

I LUV COLLEGE is a web application that provides a platform for students to anonymously share their experiences, opinions, and images of their colleges. It allows students to write reviews, upvote posts, comment anonymously, and post images, helping others discover the real side of any college. This platform also helps future college goers to get authentic and honest reviews about colleges.

Features 🌟

  • Anonymous Posting: Students can share their thoughts about colleges without revealing their identity.
  • Upvote & Comment: Users can upvote posts or leave anonymous comments to join discussions.
  • Image Uploads: Users can post images related to their college experience.
  • Real College Reviews: Find out the truth about any college from real students' experiences.
  • Responsive Design: Works seamlessly across all devices.

Tech Stack 🛠️

  • Frontend: React, Vite, Tailwind CSS, Daisy UI
  • Backend: Node.js, Express.js
  • Database: Prisma ORM with MongoDB
  • Error Tracking: Sentry.io
  • Other Libraries: React-Share, React-Toastify
  • Deployment: Vercel

Installation ⚙️

  1. Clone the repository

    git clone https://github.com/Poojan38380/i-luv-college.git
    cd i-luv-college

1.1 Open the frontend path and install frontend

cd frontend
npm install

Close the frontend route terminal

cd ..
  1. Install dependencies

    npm install
  2. Create a .env file

    Example.env is given in the files.

  3. Build the app

    npm run prisma
    npm run build
  4. Start the App

    npm run devstart
  5. For every change done make sure to build the app again

    npm run build

Contribution 🛠️

We welcome contributions to enhance I LUV COLLEGE! Please feel free to submit a pull request or open an issue if you have any suggestions or find a bug.

  1. Fork the repository
  2. Create your feature branch: git checkout -b feature/my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin feature/my-new-feature
  5. Submit a pull request 🚀

Made with ❤️ by Poojan!