Giter VIP home page Giter VIP logo

county-recommender's Introduction

Demo

To see a quick demo, feel free to watch the video one of our teammates kindly put together. You can also access the deployed site, just beware of the very long warmup time on first access (~2 min).

Development

Assuming Python 3.8 and Node installed

Setup Instructions

  1. Clone the GitHub repository: git clone https://github.com/VinnieKhanna/County-Recommender

Backend Setup

  1. cd County-Recommender/backend
  2. pip install -r requirements.txt - may take a few minutes to resolve
  3. python app.py - starts Flask server.

Frontend Setup

  1. open new terminal
  2. cd County-Recommender/frontend
  3. npm install
  4. npm run start - starts up frontend at localhost:3000.

Firebase Setup

Everyone will need to make a credential file locally for firebase since it doesn't belong in version control. Just go to the project > settings > service accounts > generate new private key. Rename the downloaded file to firebase-secrets.json and move it to the backend directory.

Deployment

Deployed by

  1. building React into static output and serving with default Flask route.
  2. deploying Flask app to Azure AppService container

county-recommender's People

Contributors

vinniekhanna avatar sdube7 avatar mknilesh avatar vedicpanda avatar redara3 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.