skapi-js 1.0.47 → 1.0.49
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -19
- package/dist/skapi.js +1 -1
- package/dist/skapi.js.map +1 -1
- package/dist/skapi.module.js +1 -1
- package/dist/skapi.module.js.map +1 -1
- package/js/main/skapi.d.ts +1 -1
- package/js/main/skapi.js +3 -3
- package/js/methods/request.d.ts +8 -0
- package/js/methods/request.js +44 -0
- package/js/methods/user.d.ts +0 -8
- package/js/methods/user.js +0 -52
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,25 +1,32 @@
|
|
|
1
1
|
# Skapi
|
|
2
2
|
|
|
3
|
-
Skapi is a backend API
|
|
3
|
+
Skapi is a backend API Library for HTML Frontend.
|
|
4
|
+
Now you can build fullstack web applications directly from your HTML frontend without the need for a backend server deployment.
|
|
4
5
|
|
|
5
|
-
|
|
6
|
+
### Compatible with both vanilla HTML and SPA projects
|
|
6
7
|
|
|
7
8
|
No fancy framework or complex deployment required. Just focused on the basics, Skapi is a single JavaScript library fully compatible with vanilla HTML, as well as any frontend frameworks.
|
|
8
9
|
|
|
9
|
-
|
|
10
|
+
### All-in-One Package
|
|
10
11
|
|
|
11
|
-
Skapi provides all the backend features you need for your web application out of the box, without the need to set up or maintain
|
|
12
|
+
Skapi provides all the backend features you need for your web application out of the box, without the need to set up or maintain any backend servers.
|
|
12
13
|
|
|
13
|
-
|
|
14
|
+
- Authentication
|
|
15
|
+
- Database
|
|
16
|
+
- File Storage
|
|
17
|
+
- CDN
|
|
18
|
+
- Automated Email Systems
|
|
19
|
+
- Realtime Messaging
|
|
20
|
+
- API Bridge for 3rd party API's
|
|
21
|
+
- Hosting
|
|
14
22
|
|
|
15
|
-
Skapi's unique database design combines the best of SQL and noSQL worlds, providing both scalability and flexibility without the need for manual schema design.
|
|
16
23
|
|
|
17
24
|
## Getting Started
|
|
18
25
|
|
|
19
26
|
### 1. Create a service
|
|
20
27
|
|
|
21
28
|
1. Signup for an account at [skapi.com](https://www.skapi.com/signup).
|
|
22
|
-
2. Log in and create a new service from
|
|
29
|
+
2. Log in and create a new service from the `My Services` page.
|
|
23
30
|
|
|
24
31
|
|
|
25
32
|
### 2. Initialize the Skapi library
|
|
@@ -27,17 +34,13 @@ Skapi's unique database design combines the best of SQL and noSQL worlds, provid
|
|
|
27
34
|
Skapi is compatible with both vanilla HTML and webpack-based projects (ex. Vue, React, Angular... etc).
|
|
28
35
|
You need to import the library using the `<script>` tag or install via npm.
|
|
29
36
|
|
|
30
|
-
|
|
37
|
+
### For HTML projects:
|
|
31
38
|
|
|
32
39
|
For vanilla HTML projects, import Skapi in the script tag, and initialize the library.
|
|
33
40
|
|
|
34
41
|
```html
|
|
35
|
-
<!-- index.html -->
|
|
36
42
|
<!DOCTYPE html>
|
|
37
43
|
<script src="https://cdn.jsdelivr.net/npm/skapi-js@latest/dist/skapi.js"></script>
|
|
38
|
-
|
|
39
|
-
<!-- Your content goes here -->
|
|
40
|
-
|
|
41
44
|
<script>
|
|
42
45
|
const skapi = new Skapi('service_id', 'owner_id');
|
|
43
46
|
</script>
|
|
@@ -45,7 +48,7 @@ For vanilla HTML projects, import Skapi in the script tag, and initialize the li
|
|
|
45
48
|
|
|
46
49
|
**Be sure to replace `'service_id'` and `'owner_id'` with the actual values of your service.**
|
|
47
50
|
|
|
48
|
-
|
|
51
|
+
### For SPA projects:
|
|
49
52
|
|
|
50
53
|
To use Skapi in a SPA projects (such as Vue, React, or Angular), you can install skapi-js via npm.
|
|
51
54
|
|
|
@@ -75,21 +78,18 @@ Below is an example of how you can use the `mock()` method in both HTML forms an
|
|
|
75
78
|
<!-- index.html -->
|
|
76
79
|
<!DOCTYPE html>
|
|
77
80
|
<script src="https://cdn.jsdelivr.net/npm/skapi-js@latest/dist/skapi.js"></script>
|
|
81
|
+
<script>
|
|
82
|
+
const skapi = new Skapi('service_id', 'owner_id');
|
|
83
|
+
</script>
|
|
78
84
|
|
|
79
85
|
<form onsubmit='skapi.mock(event).then(ping=>alert(ping.msg))'>
|
|
80
86
|
<input name='msg' placeholder='Test message'>
|
|
81
87
|
<input type='submit' value='Test Connection'>
|
|
82
88
|
</form>
|
|
83
|
-
|
|
84
|
-
<script>
|
|
85
|
-
const skapi = new Skapi('service_id', 'owner_id');
|
|
86
|
-
</script>
|
|
87
89
|
```
|
|
88
90
|
|
|
89
91
|
This will send a request to your Skapi service and ping back the response.
|
|
90
92
|
When the request is resolved, the `mock()` method will return the response data as a `Promise` object.
|
|
91
93
|
The response data will be displayed in an alert box.
|
|
92
94
|
|
|
93
|
-
Skapi is capable of handling HTML `onsubmit` event directly.
|
|
94
|
-
|
|
95
95
|
#### For more information, check out our [documentation](https://docs.skapi.com).
|