Pear-Trading/FoodLoop-Web
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
[NB - clone of https://github.com/Pear-Trading/FoodLoop-Web, no longer mirroring] https://bengoldsworthy.net/portfolio/programs/localloop/
This repository has been archived on 2023-08-16. You can view files and clone it, but cannot push or open issues or pull requests.
657 commits 37 branches 31 tags 6.8 MiB
TypeScript 40.6%
HTML 33.5%
SCSS 21.2%
CSS 3.9%
JavaScript 0.6%
Other 0.2%
Find a file
Rumperuu c0276dd253 Replace console.logs with console.debugs
2021-03-21 14:46:03 +00:00
.github/ISSUE_TEMPLATE Add guidelines, Issue templates 2021-03-20 23:39:26 +00:00
.idea Fix e2e test and actually check login works 2020-08-13 16:24:49 +01:00
bin use package config in script 2019-09-09 21:39:58 +01:00
e2e Automatic lint 2021-03-20 23:47:48 +00:00
src Replace console.logs with console.debugs 2021-03-21 14:46:03 +00:00
.editorconfig Initial CoreUI commit 2017-04-27 15:29:31 +01:00
.gitattributes added just in case for font loading file attribute 2018-01-18 12:17:35 +00:00
.gitignore More graphs with testing data 2019-07-15 01:17:01 +01:00
.travis.yml Updated api key for deploy build 2019-09-11 13:11:52 +01:00
angular.json Merge ben/fix/warnings 2020-11-30 11:35:10 +00:00
browserslist Updated versions 2019-07-02 16:46:20 +01:00
CHANGELOG.md Updated changelog and package version 2019-09-16 13:01:04 +01:00
CONTRIBUTING.md Add guidelines, Issue templates 2021-03-20 23:39:26 +00:00
Foodloop-Web.iml More graphs with testing data 2019-07-15 01:17:01 +01:00
karma.conf.js note even sure why that was there 2019-09-09 21:09:47 +01:00
LICENSE.md Rename license 2021-03-20 23:38:54 +00:00
ngcc.config.js Ignore deep import warnings 2020-11-01 11:19:22 +00:00
package-lock.json Update package.json 2021-03-20 23:40:20 +00:00
package.json Tidy up package.json 2021-03-21 14:43:58 +00:00
protractor.conf.js fix CI config 2019-09-09 20:55:21 +01:00
README.md Update readme 2021-03-21 14:44:12 +00:00
SECURITY.md Add guidelines, Issue templates 2021-03-20 23:39:26 +00:00
tsconfig.json Updated versions 2019-07-02 16:46:20 +01:00
tslint.json Updated versions 2019-07-02 16:46:20 +01:00

README.md

LocalSpend (Web App.)

Looking to discover if the value of spending local can be measured, understood and shown.

This repository contains the Web application for the LocalSpend system. See also:

Current Status

Branch Status
master Build Status
development Build Status

Table of Contents

Technology Stack

The Web app. is written in TypeScript.

The stylesheets are written in SCSS.

Technology Description Link
Node.js JavaScript server runtime Link
AngularJS JavaScript MVW framework Link

For your local Node.js, we recommend using:

We recommend Node.js version 8.0.0+ and npm version 5.3.0+.

Features

This client app. provides:

  • user authorisation (but not registration);
  • transaction logging;
  • presentation of transaction history analysis; and
  • presentation of leaderboard.

Installation

  1. Clone the repo. to your dev. environment (git clone git@github.com:Pear-Trading/FoodLoop-Web.git);
  2. enter the new directory (cd FoodLoop-Web); and
  3. install the dependencies (npm install).

Configuration

The app. defaults to using the ‘production’ environment.

App. configuration settings are found in package.json.

TypeScript configuration settings are found in tsconfig.json.

Angular configuration settings are found in angular.json.

Environment variables are found in src/environments/environment.⟨environment⟩.ts.

Usage

Development

  • Run npm run start:dev to start in development mode using Angular.
  • Run npm run build:dev to build in development mode using Angular.

Production

  • Run npm run start:prod to start in production mode using Angular.
  • Run npm run build:prod to build in production mode using Angular.

Testing

There are two types of test in this codebase:

  • unit tests; and
  • end-to-end (E2E) tests.

Unit Tests

Run npm run test to run the full test suite using Karma.

Unit tests re-run automatically on source changes.

Tests are found in *.spec.ts files alongside normal source files.

Karma configuration settings are found in karma.conf.js.

End-to-End (E2E) Tests

Run npm run e2e to run the full E2E test suite using (Selenium WebDriver](https://www.selenium.dev/documentation/en/webdriver/).

You may need to run webdriver-manager update to install the correct WebDriver and dependencies first.

E2E tests run only once and will need to be re-run manually after source changes.

Code formatting

JavaScript/TypeScript Code

  • Run npm run lint to format all JS/TS files with Codelyzer; and
  • run npm run lint-js:fix to attempt to automatically fix errors and warnings.

Codelyzer configuration settings are found in tslint.json.

Documentation

TODO

Acknowledgements

LocalLoop is the result of collaboration between the Small Green Consultancy, Shadowcat Systems, Independent Lancaster and the Ethical Small Traders Association.

The Web client interface is based off of CoreUI.

License

This project is released under the MIT license.

Contact

Name Link(s)
Mark Keating Email
Michael Hallam Email