1
- ** JAMstack Boston talk** : I'm gonna give a talk on Nov 23rd @ 6pm EST on
2
- StaticBackend. If you're interested: https://www.meetup.com/JAMstack-Boston/events/281827534/
3
-
4
-
5
1
<p align =" center " >
6
2
<img src="https://staticbackend.com/img/logo-sb-no-text.png" alt="StaticBackend logo">
7
3
<br />
@@ -17,8 +13,9 @@ StaticBackend. If you're interested: https://www.meetup.com/JAMstack-Boston/even
17
13
# StaticBackend - simple backend for your apps
18
14
19
15
[ StaticBackend] ( https://staticbackend.com ) is a simple backend that handles
20
- user management, database, file storage, forms, and real-time experiences via
21
- channel/topic-based communication for web and mobile applications.
16
+ user management, database, file storage, forms, real-time experiences via
17
+ channel/topic-based communication, and server-side functions for web and mobile
18
+ applications.
22
19
23
20
You can think of it as a lightweight Firebase replacement you may self-host. No
24
21
vendor lock-in, and your data stays in your control.
@@ -46,12 +43,15 @@ a good fit.
46
43
47
44
I'm personally using it to build SaaS:
48
45
46
+ * [ Vivid - Automatic video clips for podcasts] ( https://vivid.fm )
49
47
* [ Tangara - one page checkout for creators] ( https://tangara.io )
50
48
49
+ It can be used from client-side and/or server-side.
50
+
51
51
## How it works / dev workflow
52
52
53
53
The main idea is that StaticBackend is your backend API for your frontend apps.
54
- A performant free and open-source Firebase alternative.
54
+ A performant free and open-source self-hosted Firebase alternative.
55
55
56
56
_ Note that it can also be used from your backend code as well._
57
57
@@ -78,7 +78,7 @@ login = async () => {
78
78
console .error (res .content );
79
79
return ;
80
80
}
81
- token = res .content () ;
81
+ token = res .content ;
82
82
83
83
createTask ();
84
84
}
@@ -114,7 +114,9 @@ From there you build your application using the
114
114
the [ real-time component] ( https://staticbackend.com/docs/websocket/ ) ,
115
115
the [ storage API] ( https://staticbackend.com/docs/storage/ ) , etc.
116
116
117
- You may use server-side libraries for Node and Go or use an HTTP client
117
+ StaticBackend provides commonly used building blocks for web applications.
118
+
119
+ You may use server-side libraries for Node, Python and Go or use an HTTP client
118
120
and use your preferred language.
119
121
120
122
## Get started with the self-hosted version
@@ -128,7 +130,7 @@ Please refer to this [guide here](https://staticbackend.com/getting-started/self
128
130
129
131
We also have this
130
132
[ blog post] ( https://staticbackend.com/blog/get-started-self-hosted-version/ )
131
- that also includes the above video.
133
+ that includes the above video.
132
134
133
135
If you have Docker & Docker Compose ready, here's how you can have your server
134
136
up and running in dev mode in 30 seconds:
@@ -167,7 +169,8 @@ This is normal, as you're trying to request protected API, but you're all set.
167
169
The next step is to visit [ http://localhost:8099 ] ( http://localhost:8099 ) and
168
170
create your first app. Please note that in dev mode you'll have to look at your
169
171
docker compose output terminal to see the content of the email after creating
170
- your app.
172
+ your app. This email contains all the keys and your super user account
173
+ information.
171
174
172
175
## Documentation
173
176
@@ -182,17 +185,22 @@ Please help us improve if you have any feedback.
182
185
* [ Database] ( https://staticbackend.com/docs/database/ )
183
186
* [ Real-time communication] ( https://staticbackend.com/docs/websocket/ )
184
187
* [ File storage] ( https://staticbackend.com/docs/storage/ )
188
+ * [ Server-side functions] ( https://staticbackend.com/docs/functions/ )
189
+ * [ Send emails] ( https://staticbackend.com/docs/sendmail/ )
190
+ * [ Caching] ( https://staticbackend.com/docs/cache/ )
191
+ *
185
192
* [ Forms] ( https://staticbackend.com/docs/forms/ )
193
+ * [ Root token] ( https://staticbackend.com/docs/root-token/ )
186
194
187
195
## Librairies & CLI
188
196
189
197
We [ provide a CLI] ( https://staticbackend.com/getting-started/ ) for local
190
198
development if you want to get things started without any infrastructure and
191
- for prototyping.
199
+ for prototyping / testing. Please note the dev server has a very limited
200
+ functionalities compares to the full self-hosted version.
192
201
193
- You can use the CLI to manage your database and form submission. This is the
194
- only interface we currently have to interact with your database, other than via
195
- code. There will be a web UI available before v1.0 is released.
202
+ You can use the CLI to manage your database, form submissions, and deploy
203
+ server-side-functions. We have an alpha Web UI as well to manage your resources.
196
204
197
205
We have a page listing our
198
206
[ client-side and server-side libraries] ( https://staticbackend.com/docs/libraries/ ) .
@@ -207,12 +215,13 @@ Here's the examples we have created so far:
207
215
* [ To-do list example] ( https://staticbackend.com/getting-started/ )
208
216
* [ Realtime collaboration] ( https://staticbackend.com/blog/realtime-collaboration-example/ )
209
217
* [ Live chat using server-side function & real-time component] ( https://staticbackend.com/blog/server-side-functions-task-scheduler-example/ )
218
+ * [ Jamstack Bostom talk] ( https://www.youtube.com/watch?v=Uf-K6io9p7w )
210
219
211
220
## Deploying in production
212
221
213
222
We've not written anything yet regarding deploying, but once you have the
214
- core` built into a binary and have access to MongoDB and Redis in production you
215
- should be able to deploy it like any other Go server.
223
+ core` built into a binary and have access to either PostgreSQL or MongoDB, and
224
+ Redis in production you should be able to deploy it like any other Go server.
216
225
217
226
We'll have documentation and an example soon for deploying to DigitalOcean.
218
227
0 commit comments