@@ -13,22 +13,22 @@ vendor lock-in, and your data stays in your control.
13
13
14
14
### Table of content
15
15
16
- * [ What can you build] ( #what-can-you-build )
17
- * [ How it works / dev workflow] ( #how-it-works-dev-workflow )
18
- * [ Get started with the self-hosted version] ( #get-started-with-the-self-hosted-version )
19
- * [ Documentation] ( #documentation )
20
- * [ Librairies & CLI] ( #libraries -cli )
21
- * [ Examples] ( #examples )
22
- * [ Deploying in production] ( #deploying-in-production )
23
- * [ Feedback & contributing] ( #feedback-contributing )
24
- * [ Open source, sponsors, paid SaaS] ( #open-source-sponsors-paid-saas )
25
- * [ Spread the words] ( #spread-the-words )
16
+ * [ What can you build] ( #user-content- what-can-you-build )
17
+ * [ How it works / dev workflow] ( #user-content- how-it-works- -dev-workflow )
18
+ * [ Get started with the self-hosted version] ( #user-content- get-started-with-the-self-hosted-version )
19
+ * [ Documentation] ( #user-content- documentation )
20
+ * [ Librairies & CLI] ( #user-content-librairies- -cli )
21
+ * [ Examples] ( #user-content- examples )
22
+ * [ Deploying in production] ( #user-content- deploying-in-production" )
23
+ * [ Feedback & contributing] ( #user-content- feedback-- contributing" )
24
+ * [ Open source, sponsors, paid SaaS] ( #user-content- open-source-sponsors-paid-saas" )
25
+ * [ Spread the words] ( #user-content- spread-the-words" )
26
26
27
27
28
28
## What can you build
29
29
30
30
I built StaticBackend with the mindset of someone tired of writing the same code
31
- over and over on the backend. If you're application needs one or all of
31
+ over and over on the backend. If your application needs one or all of
32
32
user management, database, file storage, real-time interactions, it should be
33
33
a good fit.
34
34
@@ -53,15 +53,15 @@ From there each users can create database documents that are by default Read/Wri
53
53
for the owner (the user) and Read for its parent account. You may customize
54
54
permission for each of your collection (see that later in the documentation).
55
55
56
- From here you have the basics building blocks to create a typical web
57
- application. You have all your CRUD and data query operations cover , file
56
+ You have the basic building blocks to create a typical web
57
+ application. You have all your CRUD and data query operations covered , file
58
58
storage and websocket-like capabilities.
59
59
60
- We have a [ JavaScript] ( https://www.npmjs.com/package/@staticbackend/js ) to
60
+ We have a [ JavaScript library ] ( https://www.npmjs.com/package/@staticbackend/js ) to
61
61
get started quickly. We have also server-side libraries for Node and Go atm.
62
62
63
- Why would you need server-side libraries, was it not suppose to be a backend
64
- for client-side application .
63
+ Why would you need server-side libraries, was it not supposed to be a backend
64
+ for client-side applications .
65
65
66
66
Yes, but, there's always a but. Sometimes your application will need to
67
67
perform tasks on behalf of users or public user that do not have access to
@@ -83,13 +83,16 @@ when they click on the unique link on their email they received.
83
83
This can be achieve via a backend function. Couple of ways:
84
84
85
85
* The email the client received can be directly a unique URL pointing to a
86
- function as a service hosted somewhere. (We will have functions soon).
86
+ function as a service hosted somewhere. (We will have functions soon). That
87
+ function returns the invoice HTML.
87
88
* Or it could be pointing to your client-side app and you perform a call to
88
- a serverless function you're hosting somewhere.
89
+ a serverless function you're hosting somewhere. That function uses the
90
+ server-side library to perform a ` GET ` on behalf of the creator of the invoice
91
+ document, which is our customer.
89
92
90
93
The function will be able to perform a Read operation using a special ` Root Token ` .
91
94
92
- This Root Token allow your system to do anything in the server-side.
95
+ This ` Root Token ` allows your system to do anything on the server-side.
93
96
94
97
I hope I did not lost the majority of people here ;)
95
98
@@ -129,7 +132,7 @@ We have a page listing our
129
132
130
133
## Examples
131
134
132
- If you'd like to see specifics examples please let us know via the
135
+ If you'd like to see specific examples please let us know via the
133
136
[ Discussions] ( https://github.com/staticbackendhq/core/discussions ) tab.
134
137
135
138
Here's the examples we have created so far:
@@ -154,16 +157,6 @@ Same for contributing. The easiest is to get in touch first. We're working
154
157
to make it easier to contribute code. If you'd like to work on something
155
158
precise let us know.
156
159
157
- todoici
158
-
159
-
160
-
161
-
162
-
163
-
164
- We've decided to open the core of the product and have a permissive license
165
- with the MIT license.
166
-
167
160
168
161
## Open source, sponsors, paid SaaS
169
162
@@ -184,7 +177,7 @@ StaticBackend. A tweet, a blog post, any visibility is helpful and I (Dominic)
184
177
personally thanks you for this.
185
178
186
179
I've failed at getting any kind of traction with StaticBackend on its closed
187
- source form. I think developer tool like these need to be open source.
180
+ source form. I think developer tools like this need to be open source.
188
181
189
182
I believe in the product, it solves a pain I have for so long, but I'm hoping
190
183
others will also get value out of it and will be excited about the project.
0 commit comments