tnibert / Camelot

image sharing platform using django, picpicpanda.com
https://www.picpicpanda.com
GNU General Public License v3.0
0 stars 0 forks source link

Camelot

This is a nice little photo sharing web application to manage photos and share with friends and family. I've recently open sourced it. I'd like to give it a bit of love and uplift.

High level project goals:

Run Locally, Not In Docker Container

In order to run the application, you need a .env file in the project root directory defining variables:
$SECRET_KEY - django secret key
$GOOGLE_RECAPTCHA_SECRET_KEY - as it sounds
$GOOGLE_RECAPTCHA_PUBLIC_KEY - as it sounds

Then:
$ pip install -r requirements.txt
$ python manage.py migrate
$ python manage.py runserver 0:8000

Recommend creating and sourcing a venv first.
You may run docker-compose up -d to easily spin up a postgres database on port 5433. Settings.py is configured for this port.

Run Locally, In Docker Container

Need same .env file as above.

$ ./docker_manage.sh build
$ ./docker_manage.sh run

You will probably run into a problem connecting to the database from the Docker container locally.

Debian Deployment

You will need to provide the correct DATABASE_URL in your .env.
Create file deploy-debian/.env-debian as described in deploy-debian/README.

Then:
$ cd deploy-debian
$ ./deploydebian.sh
$ ./sslcertsetup.sh

May the odds be ever in your favor.

AWS Deployment

Note that AWS support is not quite production ready. Files won't be persisted.

In order to deploy onto AWS, you need a .env_aws file in the project root directory defining variables:
$REGION - the region to deploy the application in
$AWSID - the AWS user ID which will be deploying the application

There is another repository, camelot-infrastructure (https://github.com/tnibert/camelot-infrastructure) which contains Terraform code to deploy on AWS. From that repository root, run:
$ terraform init
$ terraform apply

Then from this repository root, run:
$ ./docker_manage.sh build
$ ./docker_manage.sh push

Then login to a shell with ./aws_backend_web_shell.sh and run python manage.py migrate.

You may need to run aws configure first to provide your credentials, if you haven't already.

API

The application can be interacted with via an API.
This functionality is exercised by the script at https://github.com/tnibert/project-camelot-cli.