First iteration of the Hack NYU platform http://hack-nyu.appspot.com
##Pre-reqs
- Python
- pip
- git
- Npm (Nodejs)
- Google App Engine SDK for Python
- IDE - my preference is PyCharm Ultimate Edition
##Installation: Mac/Linux and Windows
- Make sure you have python installed
- Install pip, git and npm
- Clone with git: https://github.com/hacknyu2016/webapp-one or git@github.com:hacknyu2016/webapp-one.git
- Setup flask requirements - in the root folder run:
- Mac/Linux:
python setup.py - Windows:
- Make a directory in ./main called pylibs
- run the following in the ./main folder:
pip install -t ./pylibs -r ./../requirements.txt
- Install node modules:
npm install - Install bower components:
bower install - Run Gulp to enable livereload and css generation from .less:
gulp - Run app engine server: You can do this from within PyCharm:
- Run > Edit Configurations... > Add (+): App Engine Server as a configuration
- Set the working directory as ./main
- Fix the path to the Google App Engine SDK you downloaded earlier
- On Mac: /usr/local/google_appengine
- On Linux: wherever you extracted the .tar.gz
- Run your new configuration Note: You can also run from the terminal by running dev_appserver.py '/address-to-project-dir/main'
- dev_appserver.py is found in google_appengine folder
##Installation: Windows Follow steps 1-4 from Mac/Linux installation
##Contributing to the Project
- After you have cloned the git and set up the environment, create a new branch for the feature/fix you are working on:
git checkout -b feature-projects - Add your features and push your branch frequently
- git add .
- git commit -m 'e.g. Added templates'
- git push -u origin feature-projects
- When you are ready to merge into the master branch
- git pull (you may have to fix conflicts)
- git add .
- git commit -m 'Name of your commit - e.g. Added feature-projects'
- git push -u origin master
###Tips
- To add scripts for components edit the gulpfile scripts array as gulp injects-scripts upon running Lots more to come...