Capstone-Project

Programming for All

API

How To Run:

Ensure all dependancies are installed first

1. Start instance of MongoDB on port 27017
2. In terminal/command line navigate to "$..\Capstone-Project\Backend\api"
3. Run command "$python run.py"

Dependancies:

• Python 3
• Flask
• Pymongo
• MongoDB

Dependancy Installation Instructions:

• Python 3
  • Mac/Windows: https://wiki.python.org/moin/BeginnersGuide/Download
    • Windows users make sure you add python to your environment path variables
• MongoDB
  • Mac: (I highly reccomend you take a look at installing Homebrew if you havent already. This will simplify the installation of MongoDB as well as many other libraries you may encounter... Otherwise you can install manually, this guide shows both ways.) https://docs.mongodb.com/manual/tutorial/install-mongodb-on-os-x/
  • Windows: https://docs.mongodb.com/manual/tutorial/install-mongodb-on-windows/
    • mongodb installation and setup video https://www.youtube.com/watch?v=1uFY60CESlM
• Flask
  • Mac/Windows: Once you have python installed you can simply use the command "$sudo pip install Flask"
    • Windows user: You will need to add pip to environment path variable. This video will show you how to do that. https://www.youtube.com/watch?v=mFqdeX1C-8M
• Pymongo
  • Mac/Windows: http://api.mongodb.com/python/current/installation.html
• Flask-CORS
  • This is a Flask extension that will allow handling of CORS. Simply run $sudo pip install -U flask-cors