Merge pull request #114 from Pear-Trading/ben/update-readme
Update and clean up README
This commit is contained in:
Rumperuu
GitHub
commit
5d737efcc5
1 changed files with 55 additions and 58 deletions
111
README.md
111
README.md
|
|
@ -1,30 +1,43 @@
|
||||||
# LocalLoop Web Interface
|
# LocalSpend - Web Application
|
||||||
|
|
||||||
This is the repository for the LocalLoop web interface, for traders and
|
This repository contains the Web application for the LocalSpend system.
|
||||||
customers to see and submit data to the service.
|
|
||||||
|
## Current Status
|
||||||
|
|
||||||
| Branch | Status |
|
| Branch | Status |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| *Master:* | [](https://travis-ci.org/Pear-Trading/FoodLoop-Web) |
|
| `master` | [](https://travis-ci.org/Pear-Trading/FoodLoop-Web) |
|
||||||
| *Development:* | [](https://travis-ci.org/Pear-Trading/FoodLoop-Web) |
|
| `development` | [](https://travis-ci.org/Pear-Trading/FoodLoop-Web) |
|
||||||
|
|
||||||
|
## Contents
|
||||||
|
|
||||||
|
1. [Getting Started](#getting-started)
|
||||||
|
1. [Environments](#environments)
|
||||||
|
1. [Testing](#testing)
|
||||||
|
1. [Troubleshooting](#troubleshooting)
|
||||||
|
1. [Licences](#licenses)
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
To get started with development, you will need an up to date version of
|
To get started with development, you will need an up-to-date version of
|
||||||
node.js, git, and access to either the backend dev server, or a local running
|
Node.js, git, and access to either the backend dev. server or a local
|
||||||
copy of the backend server from [LocalLoop Server][LocalLoop-Server].
|
copy of it from the [LocalSpend Server][LocalLoop-Server] repo.
|
||||||
|
|
||||||
For your local node.js, We reccomend using [n][tj/n] on \*nix and Mac, for
|
For your local Node.js, we recommend using:
|
||||||
Windows take a look at [nodist][marcelklehr/nodist] - although other options
|
- [n][tj/n] for \*nix and Mac; and
|
||||||
exist. We reccomend Node.js version 8.0.0+ and npm version 5.3.0+.
|
- [nodist][marcelklehr/nodist] for Windows.
|
||||||
|
|
||||||
To get this repository set up, first clone it and then run the following
|
We reccomend Node.js version 8.0.0+ and npm version 5.3.0+.
|
||||||
commands:
|
|
||||||
|
|
||||||
```
|
To get this repository set up:
|
||||||
npm install -g @angular/cli
|
|
||||||
npm install
|
1. Clone it
|
||||||
```
|
2. Install the dependencies:
|
||||||
|
- `npm install -g @angular/cli`
|
||||||
|
- `npm install`
|
||||||
|
3. Start the application:
|
||||||
|
- `npm start`
|
||||||
|
- The app. will automatically reload after source file changes
|
||||||
|
|
||||||
[LocalLoop-Server]:https://github.com/Pear-Trading/Foodloop-Server
|
[LocalLoop-Server]:https://github.com/Pear-Trading/Foodloop-Server
|
||||||
[tj/n]:https://github.com/tj/n
|
[tj/n]:https://github.com/tj/n
|
||||||
|
|
@ -33,11 +46,17 @@ npm install
|
||||||
## Environments
|
## Environments
|
||||||
|
|
||||||
The app defaults to using the development server. For other options, see
|
The app defaults to using the development server. For other options, see
|
||||||
`src/environments/environments.ts`
|
`src/environments/environments.ts`.
|
||||||
|
|
||||||
|
## Build
|
||||||
|
|
||||||
|
Run `ng build` to build the project; the resulting files will be stored in the `dist/` directory. Use the `-prod` flag for a production build.
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
There are two types of test in this codebase, unit tests (using Karma) and E2E tests (using Protractor).
|
There are two types of test in this codebase:
|
||||||
|
- unit tests (using Karma); and
|
||||||
|
- E2E tests (using Protractor).
|
||||||
|
|
||||||
### Karma Unit Tests
|
### Karma Unit Tests
|
||||||
|
|
||||||
|
|
@ -47,15 +66,25 @@ These tests are a long-running process, and will automatically run on file chang
|
||||||
|
|
||||||
### Protractor E2E Tests
|
### Protractor E2E Tests
|
||||||
|
|
||||||
To run these, you will need to run the following:
|
To run these, you will need to run the following command:
|
||||||
|
|
||||||
```
|
- `webdriver-manager update`
|
||||||
webdriver-manager update
|
|
||||||
```
|
|
||||||
|
|
||||||
This will download the correct webdriver for you (we use chromedriver), and any other dependencies it needs. After that, you can run the tests with `npm run e2e`. Note these run once, and will need to be re-run every time you want to run an e2e test. You will also need to run the
|
This will download the correct webdriver for you (we use chromedriver), and
|
||||||
|
any other dependencies it needs.
|
||||||
|
After that, you can run the tests with `npm run e2e`.
|
||||||
|
Note these run once, and will need to be re-run every time you want to run an
|
||||||
|
e2e test.
|
||||||
|
|
||||||
These tests are best run regularly, and should show if any issues have emerged in other parts of the application that you are not aware of, or if some part of the flow through the app has changed sufficiently.
|
These tests are best run regularly, and should show if any issues have emerged
|
||||||
|
in other parts of the application that you are not aware of, or if some part
|
||||||
|
of the flow through the app has changed significantly.
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
### ‘Error: EACCES: permission denied, access '/usr/local/lib'’ when installing dependencies
|
||||||
|
|
||||||
|
Change npm's default directory by following [these steps](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally#manually-change-npms-default-directory).
|
||||||
|
|
||||||
## Licences
|
## Licences
|
||||||
|
|
||||||
|
|
@ -65,35 +94,3 @@ The interface itself is based off of [CoreUI][core-ui] which is MIT Licenced.
|
||||||
For information, see `LICENCE.MIT` included in this repo.
|
For information, see `LICENCE.MIT` included in this repo.
|
||||||
|
|
||||||
[core-ui]: http://coreui.io
|
[core-ui]: http://coreui.io
|
||||||
|
|
||||||
# Old README
|
|
||||||
|
|
||||||
This is the old README with some minor tips on getting started, and more reading.
|
|
||||||
|
|
||||||
## Angular2DevelopmentCLI
|
|
||||||
|
|
||||||
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 1.0.0-beta.32.3.
|
|
||||||
|
|
||||||
### Development server
|
|
||||||
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
|
|
||||||
|
|
||||||
### Code scaffolding
|
|
||||||
|
|
||||||
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive/pipe/service/class/module`.
|
|
||||||
|
|
||||||
### Build
|
|
||||||
|
|
||||||
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build.
|
|
||||||
|
|
||||||
### Running unit tests
|
|
||||||
|
|
||||||
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
|
|
||||||
|
|
||||||
### Running end-to-end tests
|
|
||||||
|
|
||||||
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
|
|
||||||
Before running the tests make sure you are serving the app via `ng serve`.
|
|
||||||
|
|
||||||
### Further help
|
|
||||||
|
|
||||||
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
|
|
||||||
|
|
|
||||||
Reference in a new issue