Skip to content

Commit 083a5e9

Browse files
Readme update and fix. Ignore build
1 parent 53a44ca commit 083a5e9

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
/public/api/config/access.php
66

77
# Compiled output
8-
# /build
8+
/build
99
/dist
1010
/documentation
1111
/out-tsc

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,23 @@
22

33
TOC
44

5+
- [About](#about)
56
- [Use](#use)
67
- [Documentation](#documentation)
78
- [Testing](#testing)
89
- [Issues](#issues)
910

1011
---
1112

13+
## About
14+
15+
This proof-of-concept app is created for a friend to use as aid when selling decorative products on markets. The application is run on a smartphone and can track sales and incomes per day, instead of having to manually note these.
16+
17+
> This is the tech and skill demo version withour real application data like products.
18+
> Early, conceptual MVP phase with some features to be refined and finished on demand.
19+
20+
---
21+
1222
## Use
1323

1424
### Install
@@ -30,8 +40,9 @@ npm install
3040
### PHP + Database
3141

3242
- Install a PHP server and database that can run the API's PHP code
33-
- Adjust credentials under `public/api/config`
34-
- Initialize the database with SQL from `_internals/SQL/*.sql`
43+
- Copy credentials template from `_internals`
44+
- Adjust path to credentials under `public/api/index`
45+
- Initialize the database with SQL from `_internals/sql/*.sql`
3546
- Run the build and upload the `build` folder
3647
- Build contains the API that needs PHP and SQL to run
3748

0 commit comments

Comments
 (0)