GooseOrNot allows the user to upload a photo and decides whether that photo contains a picture of a goose ... or not!
It features a loosely coupled front-end and back-end and communicates solely through REST endpoints.
A special thanks to:
Not a particular fan of heroku but it does save me the work of manually configuring my AWS instance for this project.
Our server is just plain old gunicorn but under a reverse proxy from nginx for better performance.
As we are serving static javascript files as our front-end, using nginx as a reverse-proxy for our gunicorn server would be ideal
Due to Heroku resetting the database connection everytime we roll a new release, this quickly reduces our usable number of connections on the free dyno. Using PgBouncer can alleviate some of this problem
Setup is relatively straightforwards so I will not include a guide here.
The Arch Linux wiki has a great walkthrough which is basically universal for most -nix platforms.
One thing to watch out for is that you may need to create your own postgres user since the default data base url generated by heroku is user dependent.
Server side deployment is all in python.
I whole-heartedly recommend the direnv tool to manage environment settings.
You will need to set
DATABASE_URL=blah_blah_blah
TESTING_DATABASE_URL=blah_blah_blah
APP_SETTINGS=config._SOMETHING_Config
SERVER_NAME=example.com
S3_BUCKET_NAME=bucket_name
AWS_ACCESS_KEY_ID=super_secret
AWS_SECRET_ACCESS_KEY=super_duper_secret- Application Factory Pattern
Flask is integrated with SQLAlchemy so not much setup is required.
run the following for server migrations
python manage.py db migrate
python manage.py db upgrade
python manage.py db downgradeThe only thing to beware of is that adding a new model definition but not using it in any route or not importing it anywhere means SQLALchemy's introspection will not detect it.
A proper setup of Flask would NOT require the Application Factory Pattern but it may solve circular imports which you can fall into to escape the above issue.
Note
Always manually inspect migration files generated by alembic since no tool is perfect!
I wrote a simple script you can run interactively with ipython to verify the changes you made to the database.
run
ipython -i -m server.scripts.interactiveA variety of architectures were considered but given the limited training data, computing power, and desired performance, xgboost was chosen.
Other options explored include nnlib, sklearn, and keras.
The redis task queue is used to process client requests to run our neural network.
you will need to install redis or redis-server depending on your platform and run it (as a daemon)
the development redis worker is a simple script but is run as a daemon on our staging and development servers
SocketIO is used to keep the client up to date with the progress of the request to process a photo take note that any registered handlers for your socketio server should be in the form of a blueprint and registered in the application configuration or else nothing will happen when the client emits an event.
The ever popular pytest module is used to test server side logic, model correctness, and what not.
I would really appreciate it if anyone is willing to write more test cases.
It would really help the debugging process!
NOTE: RUN PYTEST BEFORE EACH PUSH!!
I have a pre push hook configured to run pytest and abort the push if pytest fails for some reason
the client for our websocket to process requests A mature library which integrates very well with our flask-socketIO backend
I simply modified the setup for the cookie cutter starter for typescript react.
Note that if you use vim as your editor and vim-syntastic, you may need to install typescript typescript-dev tslint globally.
Note
If you use vim as your main editor, I strongly advise installation of Quramy/tusquyomi client for the TSServer
This would technically be my first mobile project. If there's anything you notice and wish to fix, let me know!
I did not use the cookie cutter for mobile since the expo platform is still a bit too raw for my taste.
I am using openjdk8, jdk9 is not working for me but you are more than welcome to try :).
On Archlinux. You may need to enable the multilib repository for certain dependencies.
The development platforms does NOT use android-studio but feel free to install the IDE if you are more comfortble with that.
Install android-sdk, android-sdk-build-tools, android-sdk-platform-tools. We will need platforms;android-26.
Note
The react-native targeted gradle download is completely behind, I am currently using 4.9
the adb tool (android device bridge) comes with the android-sdk-platform-tools. Please do NOT install android-tool or the adb versions may not match and result in terrible things.
To accept licenses for a platform run either
sdkmanager "platforms;android-26"
sdkmanager --licensesto resolve the issue.
We may need to install the android-ndk package due to gradle issues.
You must also export certain paths for the android packages installed, this is trivially resolved by a google search so will not be provided here.
I did not test anything on the iOs platform but in theory (aka never), the react-native library should run correctly.
Please lookup up the react-native IOs guide if you wish to extend this project for the iOs platform.