Skip to content

README.md

Latest commit

 

History

History
74 lines (55 loc) · 1.87 KB

README.md

File metadata and controls

74 lines (55 loc) · 1.87 KB
Raw

Avanti fellow logo

Avanti-College Predictor

Avanti provides high-school students free test preparation programs, mentorship and career services that help them place into top-tier Science and Technology colleges across India. Our students more than double their household income on graduating and escape the cycle of intergenerational poverty.

Project Overview

The College Predictor application helps students find:

  1. A list of colleges with opening and closing ranks based on:
    • Exam
    • Category
    • Category rank
    • Round Number
    • Gender
    • Home State
  2. A list of applicable scholarships based on:
    • Scholarhship Status
    • Grade
    • Stream
    • Category
    • Family Annual Income
    • Gender
    • Home State
    • City Name

Getting Started

Prerequisites

  1. Node.js (version 14 or above)
  2. npm (comes with Node.js)

Installation

  1. Fork the college-predictor repository.
  2. Clone the forked repository to your local computer (replacing the values in {{}}): 
    git clone https://github.com/{{YOUR_GITHUB_USERNAME}}/college-predictor.git
cd college-predictor
  3. Install dependencies 
    npm install
  4. Run the local development server at http://localhost:3000 
    npm run dev

Production Run

If you want to run the app in production mode locally, first create a build and then start the server:

npm run build
npm run start