Pear-Trading/Foodloop-Server
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update Issue templates, readme

Browse source
This commit is contained in:
Rumperuu 2021-03-20 11:41:18 +00:00
parent 63fd03fb96
commit a8248f654f
3 changed files with 19 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/ISSUE_TEMPLATE/bug_report.md vendored
View file

@ -2,7 +2,7 @@
name: Bug report name: Bug report
about: Create a report to help us improve about: Create a report to help us improve
title: '' title: ''
labels: '' labels: 'bug'
assignees: '' assignees: ''
--- ---

2
.github/ISSUE_TEMPLATE/feature_request.md vendored
View file

@ -2,7 +2,7 @@
name: Feature request name: Feature request
about: Suggest an idea for this project about: Suggest an idea for this project
title: '' title: ''
labels: '' labels: 'enhancement'
assignees: '' assignees: ''
--- ---

29
README.md
View file

@ -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/). The server app. is written in [Perl](https://www.perl.org/).
| Technology | Description | Link | | Technology | Description | Link |
|-------------|---------------------|---------------------| |-------------|--------------------------------------|---------------------|
| Mojolicious | Perl Web framework | [Link][mojolicious] | | Mojolicious | Perl Web framework | [Link][mojolicious] |
| PostgreSQL | Relational database | [Linke][postgresql] | | PostgreSQL | Relational database managment system | [Link][postgresql] |
[mojolicious]: https://mojolicious.org/ [mojolicious]: https://mojolicious.org/
[postgresql]: https://www.postgresql.org/ [postgresql]: https://www.postgresql.org/
@ -46,6 +46,7 @@ This server app. provides:
- user creation, updating and deletion; - user creation, updating and deletion;
- organisation creation, updating and deletion; - organisation creation, updating and deletion;
- an admin. management portal;
- transaction logging; - transaction logging;
- transaction history analysis; and - transaction history analysis; and
- leaderboard generation. - 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`. - if you are using a PostgreSQL database, replace `--with-feature=sqlite` with `--with-feature=postgres`.
1. install the database: 1. install the database:
- development supports both SQLite and PostgreSQL, however production uses PostgreSQL; - run `./script/deploy_db install -c 'dbi:SQLite:dbname=foodloop.db'`;
- for this example we will use SQLite; - 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. - 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: 1. set up the development users:
- `./script/pear-local_loop dev_data --force` - `./script/pear-local_loop dev_data --force`
- **DO NOT RUN ON PROD.** - **DO NOT RUN ON PROD!**
1. start the [minion](https://docs.mojolicious.org/Minion) job queue: 1. start the [Minion](https://docs.mojolicious.org/Minion) job scheduler:
- `./script/pear-local_loop minion worker` - `./script/pear-local_loop minion worker`
1. import ward data: 1. import ward data:
1. Download the CSV(s) from [here](https://www.doogal.co.uk/PostcodeDownloads.php); and 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`. 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 ## 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; and
- run `./script/pear-local_loop minion worker` to start the Minion asynchronous job scheduler. - run `morbo script/pear-local_loop -l http://*:3000` to start the server on the specific hostname and port.
### Database Scripts ### 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 `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). - 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 ## Code Formatting
TODO TODO