Metadata-Version: 2.4
Name: marinerg_backend
Version: 0.2.2
Summary: An web app for project access applications.
Author-email: Irish Centre for High End Computing <james.grogan@ichec.ie>
Project-URL: Repository, https://git.ichec.ie/marinerg-i/backend
Project-URL: Homepage, https://git.ichec.ie/marinerg-i/backend
Keywords: Web Application,Django
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: marinerg_test_access==0.2.2
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: pytest-sugar; extra == "test"
Requires-Dist: beautifulsoup4; extra == "test"
Requires-Dist: black; extra == "test"
Requires-Dist: flake8; extra == "test"
Requires-Dist: pylint; extra == "test"
Requires-Dist: mypy; extra == "test"
Requires-Dist: requests; extra == "test"
Requires-Dist: types-requests; extra == "test"
Requires-Dist: faker; extra == "test"
Requires-Dist: faker-file[docx,images,pdf]; extra == "test"
Provides-Extra: container
Requires-Dist: psycopg2-binary; extra == "container"
Requires-Dist: gunicorn; extra == "container"
Provides-Extra: types
Requires-Dist: types-requests; extra == "types"
Dynamic: license-file

# Marinerg-i Backend #

This software is part of the [Marinerg-i preparatory phase project](https://www.marinerg-i.eu).

It combines all Marinerg backend service modules into a monolithic application.

# Quick Start #

This is a Python `Django` application and can be managed through the standard Django APIs.

If you want a quick demo of it running locally you can inspect this script on Linux or Mac and run it if happy with it:

``` sh
./infra/quick_start.sh
```

which will:

* Set up a Python virtual environment and install dependencies
* Populate the shell environment with demo Django settings, such as Admin credentials
* Set up a local database and create an admin user
* Launch the development server

You can then go to [localhost:8000/api](http://localhost:8000/api) in a browser to interact with the backend API.

For more detailed deployment information more suitable for production you can see the [Developer Guide](/docs/DeveloperGuide.md).

# Licensing #

This software is copyright of the Irish Centre for High End Computing (ICHEC). It may be used under the terms of the GNU AGPL version 3 or later, with license details in the included `LICENSE` file. Exemptions are available for Marinerg project partners and possibly others on request.
