Saulify for Web

Got a hard-to-read website? Better call Saul to clean it up!

Saulify runs on Heroku: http://saulify.heroku.com

Installing Locally

Saulify is built on Python using the Flask micro-framework.

To install it locally:

• Clone this Github repo to your local computer.
• Install Heroku Toolbelt and ensure you create a Heroku account if you don't have one already.
• Install virtualenv-burrito to install a tool for managing your Python virtual environments.
• Use mkvirtualenv saulify to create a new virtual environment for the project. This will ensure all of your Python libraries are installed properly without conflict.
• Use cd <saulify folder path> to change to the Saulify directory and then workon saulify to switch to the Saulify virtual environment you created previously.
• Use pip install -r requirements.txt to install the 3rd party dependencies, such as Flask, et. al.
• Set up a .env file in the root Saulify directory with the environment variables taken from the Heroku config: https://devcenter.heroku.com/articles/config-vars (Ask a team member to send you the file if you don't have access)
• Type foreman run python runserver.py (for development) or foreman start (for production) at the command line to start the local server.

Note: Saulify uses the Newspaper library for scraping website articles. If you have trouble installing it on Mac OS X Yosemite during the pip install process above, please see this Github issue for helpful info.

More info here for getting started w/ Python on Heroku.

Testing

Saulify uses the pytest framework for making sure we keep clear of new bugs and regressions and these tests can be found in the /tests directory.

You'll need to set an .env variable for the TEST_DATABASE_URL to be a local or remote database that you want to use specifically for testing.

Then you can run the test suite via the command line using:

$ foreman run py.test

Also, we have a secondary test script for verifying the accuracy of the article scraper recipes. You can run that script via the command line using:

$ python runreport.py -p

Contributing

This is a product being built by the Assembly community. If you'd like to contribute to Saulify, we'd love to have the help!

Please follow these steps:

• Go to https://assemblymade.com/saulify and sign up for an Assembly account.
• Link your GitHub account to your Assembly account in your profile settings.
• Fork this repo asm-products/saulify-web
• Find a bounty you'd like to work on (or create a new one) and commit your code to your fork
• Open up a new pull request on Github into the development branch and let us know what bounty the code changes are for.
• We'll review the code, give any feedback, merge it, and award you the bounty (which gives you ownership over Saulify)!

===

Made by Assembly

Assembly products are like open-source and made with contributions from the community. Assembly handles the boring stuff like hosting, support, financing, legal, etc. Once the product launches we collect the revenue and split the profits amongst the contributors.

Visit https://assembly.com to learn more.