Skip to content

ajay-jayanth/college-mapper

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 

Repository files navigation

College Mapper

Purpose

The purpose of this project is to create a web application to allow people to search for colleges and college information in an easy-to-use map interface. They should be able to save colleges they like, and add relevant times for things like application due-dates to keep track of their college process.

How to Run

To run for development, you must start the server and run the client. The server allows you to retrieve the necessary data, and the client enables you to see the app itself.

If you haven't already:

Running the Server

Navigate into the API directory: cd api

Install the required packages: pip install -r requirements.txt (Note: Depending on the setup of your system, you may need to use pip3)

Run the server. python3 main.py (Server runs on localhost:5000)

Running the Client (Website):

Navigate into the client directory: cd client

Install the packages and run: yarn && yarn start

The website will be up and running on localhost: 3000 by default.

Getting Help

If you need help getting the project running, contact Nathaniel on Facebook Messenger or email tamsopensource@gmail.com.

About

Join us on our quest to make an accessible "college mapping" app using Python and ReactJS!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Python 72.2%
  • JavaScript 15.1%
  • HTML 12.7%