index.rst

Welcome to NearBeach

NearBeach is an Open Source Project Management system built on the Django framework. NearBeach.org

Note

NearBeach is licensed under the MIT license

Note

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

Minimum requirements

Hardware

• 1GB RAM
• 1+ Core CPU (for small user base)
• 5+ GB Space (more for uploading documents)

Software

• Ubuntu 20.04
• Python 3.6+
• Django 3.1+
• Nginx
• Gunicorn
• MySQL

.. toctree::
  :maxdepth: 1
  :caption: Local Development Environment setup
  :name: sec-setup-dev-environment

  setup-dev-environment/easy_development_environment
  setup-dev-environment/complicated_development_environment

.. toctree::
  :maxdepth: 1
  :caption: Installation of NearBeach
  :name: sec-installation

  installation/installation_of_server
  installation/installation_of_django
  installation/installation_of_mysql_server
  installation/installation_of_nearbeach
  installation/installation_of_optional_steps
  installation/trouble_shooting_issues


  ------------------
  After Installation
  ------------------

.. toctree::
  :maxdepth: 1
  :caption: Administration tasks
  :name: sec-administration-tasks

  administration-tasks/first-time-setup
  administration-tasks/configuration

.. toctree::
  :maxdepth: 1
  :caption: Basic usage
  :name: sec-basic-usage

  basic-usage/nearbeach-flow
  basic-usage/requirements-and-requirement-items
  basic-usage/projects
  basic-usage/tasks
  basic-usage/requests-for-change
  basic-usage/basic-modules

.. toctree::
  :maxdepth: 1
  :caption: Update or Patch NearBeach
  :name: sec-update-or-patch-nearbeach

  update/update_or_patch_nearbeach
  update/update_python_libraries

.. toctree::
  :maxdepth: 1
  :caption: Setting up Development Environment
  :name: sec-setup-dev-environment

  setup-dev-environment/setup_development_environment