Skip to content

Commit 2a6f527

Browse files
authored
Update README.md
1 parent 7ca9401 commit 2a6f527

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# webapi-b4j
2-
A boilerplate for creating CRUD based Web API.
2+
Version: 1.11
33

4-
B4X Client app: https://github.com/pyhoon/webapi-client-b4x
4+
A boilerplate for creating CRUD based Web API.
55

66
**Depends on following libraries:** ByteConverter, JavaObject, jServer, Json, jSQL
77

8-
# Features:
8+
**B4X Client app:** https://github.com/pyhoon/webapi-client-b4x
9+
10+
# Features
911
- CRUD based - REST-API style (GET, POST, PUT, DELETE)
1012
- Front-end (HTML, CSS, JS, Bootstrap)
1113
- Support **MySQL** and **SQLite** database (Can be modified for MS SQL or SQL Express)
@@ -14,7 +16,11 @@ B4X Client app: https://github.com/pyhoon/webapi-client-b4x
1416
- Versioning (using ROOT_PATH in config.ini, set as "/" if you don't want versioning)
1517
- Auto generated documentation with API test.
1618

17-
# How to use:
19+
# Create B4X template from source
20+
1. Archive the files inside "Web API" directory as "Web API.zip" using WinRAR or 7-Zip
21+
2. Rename the extension from .zip to .b4xtemplate
22+
23+
# How to use
1824
1. Copy the "Web API.b4xtemplate" file into B4J platform Additional folder.
1925
2. Open B4J and create a new project with "Web API" template. Give your project any name you like, for e.g. WebAPI
2026
3. Run the project in Debug or Release mode. You will see something like this in the Logs:
@@ -29,10 +35,10 @@ http://127.0.0.1:19800/v1/
2935
7. In B4J project, comment the line '#AdditionalJar: sqlite-jdbc-3.36.0.2 and uncomment the line #AdditionalJar: mysql-connector-java-5.1.49-bin. (Make sure you are using the correct version of connector)
3036
8. Follow step #3 above.
3137

32-
**Preview:**
38+
**Preview**
3339
<img src="https://github.com/pyhoon/webapi-b4j/raw/main/Preview/web-api.png" title="Web API" />
3440

35-
**YouTube:**
41+
**YouTube**
3642

3743
[![Alt text](https://img.youtube.com/vi/Y-1HDR2k_fE/0.jpg)](https://youtu.be/Y-1HDR2k_fE)
3844

0 commit comments

Comments
 (0)