bookbrainz/bookbrainz-site

/*
 * Copyright (C) 2015  Ben Ockmore
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

import React from 'react';


/**
 * Renders the document and displays the 'Develop' page.
 * @returns {JSX.Element} a React JSX Element
 */
function DevelopPage(): JSX.Element {
    return (
        <div>
            <div className="page-header">
                <h1>Developing with BookBrainz</h1>
            </div>
            <p className="lead">
                We aim to make it as easy as possible to use the data
                stored in BookBrainz. If you&rsquo;re a developer wanting
                to make programs that depend on BookBrainz, we have a web
                service available, and are releasing database
                dumps regularly.
            </p>

            <h2>Web Service / API</h2>
            <p>
                The web service is the primary way of getting BookBrainz
                data. The key advantage of using the web service over the
                dumps is that you don&rsquo;t need to install any database
                engine &mdash; you can access the data through the internet.
                The web service is currently in alpha version and a&nbsp;
                <a href="https://api.test.bookbrainz.org/1/docs/">
                    live documentation is served at this address
                </a>.
            </p>

            <h2>Database Dumps</h2>
            <p>
                The database dumps will be useful if you need to process a
                lot of data quickly &mdash; in cases where the web service
                is not able to respond quickly enough.
                The latest database dump can be found <a href="ftp://ftp.musicbrainz.org/pub/musicbrainz/bookbrainz/latest.sql.bz2">at this address</a>.
                A dump is made every week.
            </p>
            <h2>Source Code</h2>
            <p>
                BookBrainz runs on open source software. If you wish to
                access the source and contribute to the project, please
                see&nbsp;
                <a href="https://github.com/metabrainz/bookbrainz-site">
                    our github page
                </a>.
            </p>
        </div>
    );
}

DevelopPage.displayName = 'DevelopPage';

export default DevelopPage;