Welcome to NearBeach
====================

.. image:: https://img.shields.io/github/license/robotichead/NearBeach
.. image:: https://img.shields.io/pypi/v/NearBeach
.. image:: https://img.shields.io/circleci/build/github/robotichead/NearBeach/master
.. image:: https://img.shields.io/codeclimate/maintainability/robotichead/NearBeach

------------------
What is NearBeach?
------------------

NearBeach is an Open Source Project Management system built using VueJS and the Django framework. `NearBeach.org <https://nearbeach.org/>`_. You can;

* Record basic Organisation and customer data
* Gather user requirements for tracking purposes
* Build Kanban Boards
* Create projects/tasks for deliverying
* Plan out your development using Sprints
* Setup Request for Changes (RFC) for deployments



.. note:: NearBeach is licensed under the MIT license

.. note:: If you want to setup a local development environment, please view our :ref:`local_development_environment`.

.. note:: If you want to deploy a docker build of NearBeach, please view our :ref:`quick-install-docker`.

-----------
Who are we?
-----------

Welcome to NearBeach. We are a small community of developers trying to make tools to help you manage your projects. Why not 
`join our community <https://discord.gg/fbhSjdnv>`_ and we can build the tools that you require.

.. toctree::
    :maxdepth: 2
    :hidden:
    :caption: 🚀 About

    Features </000-about/features>
    NearBeach Flow </000-about/nearbeach-flow>


.. toctree::
    :maxdepth: 2
    :hidden:
    :caption: 💡 Installation

    Quick Install with Docker </001-installation/quick-install-with-docker>
    Quick Install with Podman </001-installation/quick-install-with-podman>
    Different Databases </001-installation/different-databases/index>
    Different Blob Storage </001-installation/different-blob-storage/index>
    Install Against Existing Project </001-installation/install-against-existing-project/index>
    Old Installation Process </001-installation/old-installation-process/index>


.. toctree::
    :maxdepth: 2
    :hidden:
    :caption: 🏸 Local Development Environment Setup

    Local Development Environment </002-local-development-environment-setup/index>


.. toctree::
    :maxdepth: 2
    :hidden:
    :caption: 🎣 Administration Tasks

    First Time Setup </003-administration-tasks/index>

.. toctree::
    :maxdepth: 2
    :hidden:
    :caption: 🪀 Basic Usage

    Basic Usage </004-basic-usage/index>

.. toctree::
    :maxdepth: 2
    :hidden:
    :caption: 🤕 Comman Usage

    Common Usage </005-common-usage/index>

.. toctree::
    :maxdepth: 2
    :hidden:
    :caption: 🛝 Procedure

    Procedures </006-procedures/index>

.. toctree::
    :maxdepth: 2
    :hidden:
    :caption: 🥋 Misc

    Misc </007-misc/index>

