Circa

Buy and Sell Locally

Circa is a platform for local buying and selling. It creates a hassle-free experience by handling payments, delivery, and returns. Cheaper than Amazon, safer than Craigslist!

Circa was originally created by Gautam Narula and Andrew Schuster, co-founders (and Chief Donut Procurer and Chief Delivery Boy, respectively) of Centaurii, Inc. Now that Centaurii is defunct, Gautam (me) has open-sourced the code. Circa will remain in test mode at www.usecirca.com.

To run your own instance of Circa, do the following:

1. Clone this repo and install Pip if you don't already have it.
2. Use your terminal to navigate to the directory with requirements.txt and run pip install -r requirements.txt. This will install all the necessary packages to run Circa.
3. You will need to generate your own secret key in the Django settings file at circa/circa/settings.py. You will also have to change ALLOWED_HOSTS and SITE_DOMAIN to the appropriate values if you plan on running this in production. Do not keep the settings file under version control.
4. You will need fill in your API keys in core/keys.py, which requires your Stripe API keys to process real or test payments and keys for other services (social auth, transactional email, etc.). You can get these API keys by creating a Stripe account and following their instructions. Do not keep the keys file under version control.
5. You will need to create a database and migrations. Navigating to the directory with manage.py and running python manage.py migrate should take care of that. If you'd like to use a database other than the default sqlite3, you'll have to do additional configuration.
6. Run 'python manage.py runserver' to run a local instance of Circa. That's it! Please note that Circa is not compatible with Python 2.x.

Notes

1. When debug=true in settings.py, the site goes into test mode and the test Stripe API keys are automatically used instead of the live ones. Look at the Stripe documentation for test mode to see how to simulate credit card transactions.
2. If you plan on doing real credit card transactions, make sure you have SSL (HTTPS) enabled on your site! Not doing so means your users' credit card information will be sent unencrypted over the interwebz.
3. I keep getting weekly email alerts from Github about security vulnerability unless I update the requirements.txt via dependabot PRs, so out of sheer laziness I've started doing that. I don't think there's anything that should cause something to break, but it's possible there could be minor issues due to updated dependencies deprecating some of the code.
4. This code is licensed under the MIT license. If you do something cool with it, I'd love to hear about it!
5. The EMAIL_BACKEND and DEFAULT_FROM_EMAIL will have to be updated accordingly. Also, Mandrill doesn't really work the way it did when we were using it for Circa, so keep that in mind.