Skip to content

Latest commit

 

History

History
160 lines (115 loc) · 6.73 KB

README.md

File metadata and controls

160 lines (115 loc) · 6.73 KB
Raw


MetaBrainz

GitHub last commit GitHub issues GitHub pull requests

Website for the MetaBrainz Foundation. This is a Flask-based web application that provides info about the foundation and its supporters, accepts donations from users and organizations, and provides access to the replication packets for MusicBrainz.

Doing a Release

Like other PythonBrainz, this repository also has GitHub Actions setup to help do a release. A docker image is built and pushed to docker hub whenever a release is made from GitHub. Following are the steps to do a release:

  1. Navigate to the Releases page. More info about releases is available here.
  2. You should see a Draft Release at the top. Click on the Edit button next to it.
  3. In the Tag Version field, enter the tag you want to docker image to be tagged with. For example, if you enter v-2021-06-08.0 as the tag, the corresponding docker image will be metabrainz/metabrainz:v-2021-06-08.0.
  4. Click on Publish release.

Note:

  1. The status of the build can be checked from the Actions page.
  2. The release title field is ignored by the action. It can be set to any value we wish. We usually set it to the tag of that release.
  3. The release description is only updated with titles of merged PRs not commits pushed directly to master.

Development setup

The easiest way to set up MetaBrainz website for development is to use Docker. Make sure that it is installed on your machine before following the instructions.

Configuration

The app configuration must be stored in the file called config.py. You can use an example one (config.py.example) and tweak the configuration:

$ cp config.py.example config.py
$ vim config.py

You need to make sure that required variables are set.

MusicBrainz OAuth

To allow users to log in, you'll need to set two keys: MUSICBRAINZ_CLIENT_ID and MUSICBRAINZ_CLIENT_SECRET. To obtain these keys, you need to register your instance of MetaBrainz.org on MusicBrainz at https://musicbrainz.org/account/applications/register. Set Callback URL field to http://<your host>/login/musicbrainz/post (if PREFERRED_URL_SCHEME in the config file is set to https, make sure that you specify the same protocol for callback URL). If you run the server locally, replace <your host> with localhost.

Payments

Next is the configuration of the payment systems. We use PayPal and Stripe to accept payments to our foundation. PAYPAL_ACCOUNT_IDS dictionary contains PayPal IDs or email addresses of accounts for each supported currency. PAYPAL_BUSINESS is an address for non-donations; all payments sent there will be ignored.

After these settings have been set and you are sure that your configuration is working properly within test mode, you can flip the switch. Set DEBUG to False and PAYMENT_PRODUCTION to True. WARNING! For development purposes, you should only use payments in debug mode.

Serving replication packets

Replication packets must be copied into ./data/replication_packets directory. It must have the following structure:

./data/replication_packets/
    - hourly replication packets

Startup

This command will build and start all the services that you will be able to use for development:

$ ./develop.sh

The first time you set up the application, the database needs to be initialized:

$ ./develop.sh manage init-db --create-db

The web server should now be accessible at http://localhost:80/.

Building style sheets

Due to the way development environment works with Docker, it's necessary to build CSS separately from building an image. To do that you need to start the development server (all the containers with Docker Compose) and attach to the web container:

$ ./develop.sh exec -it web bash

Then install npm modules and build CSS:

web# npm install
web# ./node_modules/.bin/lessc ./metabrainz/static/css/main.less > ./metabrainz/static/css/main.css
web# ./node_modules/.bin/lessc ./metabrainz/static/css/theme/boostrap/boostrap.less > ./metabrainz/static/css/theme/boostrap/boostrap.css
web# ./node_modules/.bin/lessc ./metabrainz/static/fonts/font_awesome/less/font-awesome.less > ./metabrainz/static/fonts/font_awesome/less/font-awesome.css

Last two builds are necessary only if you are planning to use the admin interface.

Translations

Extracting strings

Once you have built and started all the services as mentioned above, run:

$ ./develop.sh manage extract-strings

Compiling the strings

The POT files are compiled automatically every time the services are built, but in case you make any changes to the POT files and want to compile the translation files again, run:

$ ./develop.sh manage compile-translations

Testing

To run all tests use:

$ ./test.sh

Testing payments

Before doing anything make sure that the PAYMENT_PRODUCTION variable in the configuration file is set to False! This way you'll use testing environments where credit cards and bank accounts are not actually charged. More info about testing environments for each payment service can be found in their documentation:

Please note that for IPNs to work, the application MUST be publicly available. If you are doing development on your local machine it is likely that your callback endpoints will not be reachable for payment processors.