amanbind898 / college-nexus

https://college-nexus.onrender.com/
1 stars 1 forks source link
hacktoberfest hactoberfest-accepted

College Nexus: College Review & Counseling Platform

Welcome to College Nexus, an open-source web app designed to help students find their ideal college based on reviews, counseling, and a JEE Main college predictor. This app was initially developed using HTML, CSS, and JavaScript, and now it's migrating to Next.js to provide more robust functionality, better performance, and easier contributions!

šŸŒŸ Features

šŸ› ļø Tech Stack

šŸš€ Getting Started

Prerequisites

Installation

  1. Clone the Repository

    git clone https://github.com/yourusername/college-nexus.git
    cd college-nexus
  2. Install Dependencies

    npm install
  3. Run the Development Server

    npm run dev

    Open http://localhost:3000 to view it in the browser.

Build for Production

To create an optimized build for production, run:

npm run build

Then, start the server:

npm start

šŸ“‘ Contribution Guidelines

We're participating in Hacktoberfest 2024, and we welcome contributions from the community! Here's how you can contribute:

  1. Fork the Repository on GitHub.
  2. Create a New Branch for your feature or bug fix.
    git checkout -b feature/your-feature-name
  3. Commit your Changes with clear messages.
    git commit -m "Add new feature: your feature name"
  4. Push to your Fork and submit a Pull Request.
    git push origin feature/your-feature-name

    All contributions are welcome, from fixing a small typo to creating new features or enhancing the UI/UX!

šŸ“§ Contact

For questions or suggestions, feel free to reach out or submit an issue. You can also connect with the project maintainer on LinkedIn or Instagram.