cybercinch/openaccounting-web
0
0
Fork 1
mirror of https://github.com/openaccounting/oa-web.git synced 2025-12-09 09:01:24 +13:00
Code Issues Actions Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Patrick Nagurny
2018-11-12 11:36:00 -05:00
parent 8a86ad060a
commit 1da37c3d12
1 changed files with 17 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -1,5 +1,18 @@
# Open Accounting Web Interface
This is the front-end web interface for Open Accounting. It communicates with the [server](https://github.com/openaccounting/oa-server) over a [REST API](https://openaccounting.io/api).
## Dev Environment
This software is built with Angular. To get started, make sure you have [Node](https://nodejs.org) installed.
Then follow these steps:
1. `git clone https://github.com/openaccounting/oa-web.git`
2. `cd oa-web`
3. `npm install`
## Development server
@@ -9,14 +22,11 @@ Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app w
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
## Choose API server
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
Click on the Settings link and specify the URL for your [server](https://github.com/openaccounting/oa-server). Or you can use https://api.openaccounting.io if you want Open Accounting to host your information.
## Running end-to-end tests
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
## Help
## 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).
[Join our Slack chatroom](https://openaccounting.slack.com/signup) and talk with us!