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>


.. toctree::
    :maxdepth: 2
    :hidden:
    :caption: 🏸 For Developers

    Setup Local Dev Env </002-local-development-environment-setup/index>


.. toctree::
    :maxdepth: 2
    :hidden:
    :caption: 🎣 For Administrators

    First Time Setup </003-administration-tasks/first-time-setup>
    Manage Users </003-administration-tasks/manage-users>
    Manage Groups </003-administration-tasks/manage-groups>
    Manage Permission Sets </003-administration-tasks/manage-permission-sets>
    System Variables </003-administration-tasks/system-variables>
    API </003-administration-tasks/api>

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

    Organisations </004-basic-usage/organisation/organisation_crud>
    Customers </004-basic-usage/customer/customer_crud>
    Requirements </004-basic-usage/requirement/requirement_crud>
    Requirement Items </004-basic-usage/requirement-item/requirement_item_crud>
    Kanban Board </004-basic-usage/kanban-board/kanban_board_crud>
    Projects </004-basic-usage/project/project_crud>
    Tasks </004-basic-usage/task/task_crud>
    Spring </004-basic-usage/sprint/sprint_crud>
    Request for Change </004-basic-usage/request-for-change/request_for_change_crud>
    Common Usage </004-basic-usage/common-usage/index>


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

    Deployment of NearBeach </006-procedures/deployment/deployment>
    Git Flow for NearBeach </006-procedures/git-flow/git-flow>


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

    Misc </007-misc/index>