From a8248f654fd320eab39a0d8a338b078a8139e892 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Sat, 20 Mar 2021 11:41:18 +0000 Subject: [PATCH] Update Issue templates, readme --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- README.md | 29 +++++++++++++---------- 3 files changed, 19 insertions(+), 14 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea7..81c7b58 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -2,7 +2,7 @@ name: Bug report about: Create a report to help us improve title: '' -labels: '' +labels: 'bug' assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7..36014cd 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,7 +2,7 @@ name: Feature request about: Suggest an idea for this project title: '' -labels: '' +labels: 'enhancement' assignees: '' --- diff --git a/README.md b/README.md index 030060a..df4dbd5 100644 --- a/README.md +++ b/README.md @@ -32,10 +32,10 @@ This repository contains the server application for the LocalSpend system. See a The server app. is written in [Perl](https://www.perl.org/). -| Technology | Description | Link | -|-------------|---------------------|---------------------| -| Mojolicious | Perl Web framework | [Link][mojolicious] | -| PostgreSQL | Relational database | [Linke][postgresql] | +| Technology | Description | Link | +|-------------|--------------------------------------|---------------------| +| Mojolicious | Perl Web framework | [Link][mojolicious] | +| PostgreSQL | Relational database managment system | [Link][postgresql] | [mojolicious]: https://mojolicious.org/ [postgresql]: https://www.postgresql.org/ @@ -46,6 +46,7 @@ This server app. provides: - user creation, updating and deletion; - organisation creation, updating and deletion; +- an admin. management portal; - transaction logging; - transaction history analysis; and - leaderboard generation. @@ -62,14 +63,14 @@ This server app. provides: ``` - if you are using a PostgreSQL database, replace `--with-feature=sqlite` with `--with-feature=postgres`. 1. install the database: - - development supports both SQLite and PostgreSQL, however production uses PostgreSQL; - - for this example we will use SQLite; + - run `./script/deploy_db install -c 'dbi:SQLite:dbname=foodloop.db'`; + - development supports both SQLite and PostgreSQL (production uses PostgreSQL); + - for this example we will use SQLite; so - as the default config. is set up for this, no configuration changes are needed initially. - - run `./script/deploy_db install -c 'dbi:SQLite:dbname=foodloop.db'`. 1. set up the development users: - `./script/pear-local_loop dev_data --force` - - **DO NOT RUN ON PROD.** -1. start the [minion](https://docs.mojolicious.org/Minion) job queue: + - **DO NOT RUN ON PROD!** +1. start the [Minion](https://docs.mojolicious.org/Minion) job scheduler: - `./script/pear-local_loop minion worker` 1. import ward data: 1. Download the CSV(s) from [here](https://www.doogal.co.uk/PostcodeDownloads.php); and @@ -93,12 +94,14 @@ This server app. provides: App. configuration settings are found in `pear-local_loop.⟨environment⟩.conf`. -[Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/) (FCM) credentials should be placed in a file called `localspend-47012.json` in root. +[Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/) (FCM) credentials should be placed in a file called `localspend-47012.json` in root. This file is not tracked by Git; ask another developer for a copy. + +Default user credentials are found in `lib/Pear/LocalLoop/Command/dev_data.pm`. ## Usage -- Run `morbo script/pear-local_loop -l http://*:3000` to start the server; and -- run `./script/pear-local_loop minion worker` to start the Minion asynchronous job scheduler. +- Run `./script/pear-local_loop minion worker` to start the Minion asynchronous job scheduler; and +- run `morbo script/pear-local_loop -l http://*:3000` to start the server on the specific hostname and port. ### Database Scripts @@ -115,6 +118,8 @@ Run `./script/pear-local_loop recalc_leaderboards` to update the leaderboards. - Run `prove -lr` to run the full test suite using [Test-Simple](https://metacpan.org/release/Test-Simple) (when using an SQLite database); and - run `PEAR_TEST_PG=1 prove -lr` to run the full test suite (when using a PostgreSQL database). +Test files are found in the `t/` directory. + ## Code Formatting TODO