saltchang / caten-music

A Full-stack web application of music data for church.

Caten Music

A music web application for Caten Church.

• View and search the songs you need.

• Signing up to create a songlist and share it to your partner.

• Become an admin and create a new song, or edit an old one.

• See Changelog

• Also see Church Music API

Stack

• Python
• Flask
• PostgreSQL
• Docker
• Heroku
• DropBox API

Released

[0.6.0] - 2020-11-27

• Update church music api url

Quick Start

Installation

To launch the app locally and quickly, use the sample env file.
Run the command to create a local environment file from default:

cp env.test .env

See Environment Variables for more information.

Build & Run

Make sure you have Docker installed and then continue.

1. Build the app with docker-compose:

   docker-compose build

2. Launch the app:

   docker-compose up -d

   Visit http://localhost:5000 then you will see the website.

3. See log of the service

   • Use the terminal:

   docker-compose logs -f

   • Or use your docker GUI

Environment Variables

The format of the .env file must be like the following content:

DROPBOX_ACCESS_TOKEN=<Dropbox_API_token>
DATABASE_URL=<DATABASE_URL>
DATABASE_URL_FOR_DEVELOPMENT=<DATABASE_URL_FOR_DEVELOPMENT>
DATABASE_URL_FOR_TESTING = <DATABASE_URL_FOR_TESTING>
APP_SETTING=<Mode:[Production, Development, Testing]>
TEST_SETTING=Testing
MAIL_USERNAME=<Mail_Account_Username>
MAIL_PASSWORD=<Mail_Account_Password>
HASH_SALT=<Hash_Salt>
SECRET_KEY=<Secret_Key>
FLASK_APP=run.py