1
- # StaticBackend - simple backend for web & mobile apps
1
+ <p align =" center " >
2
+ <img src="https://staticbackend.com/img/logo-sb-no-text.png" alt="StaticBackend logo">
3
+ </p >
4
+
5
+ # StaticBackend - simple backend for your apps
2
6
3
7
[ StaticBackend] ( https://staticbackend.com ) is a simple backend that handles
4
- user management, database, file storage, and real-time experiences via
8
+ user management, database, file storage, and real-time experiences via
5
9
channel/topic-based communication for web and mobile applications.
6
10
7
11
You can think of it as a lightweight Firebase replacement you may self-host. No
@@ -51,7 +55,14 @@ AWS_SES_ENDPOINT=https://email.us-east-1.amazonaws.com
51
55
$> make start
52
56
```
53
57
54
- ### usage
58
+ ### Usage
59
+
60
+ You have multiple options to use the backend:
61
+
62
+ * You may use our server-side client libraries (currently
63
+ [ Go] ( https://github.com/staticbackendhq/backend-go ) and [ Node] ( https://github.com/staticbackendhq/backend-node ) )
64
+ * From your client-side applications using our [ JavaScript library] ( https://github.com/staticbackendhq/backend-js )
65
+ * You may use your own HTTP client
55
66
56
67
To start using the backend you'll need to create an account on your local
57
68
instance.
@@ -75,7 +86,24 @@ or server-side application.
75
86
Refer to [ our main documentation] ( https://staticbackend.com/docs/ ) for more
76
87
information.
77
88
89
+ ### Deploying in production
90
+
91
+ We've not written anything yet regarding deploying, but once you have the
92
+ ` core ` built into a binary and have access to MongoDB and Redis in production you
93
+ should be able to deploy it like any other Go server.
94
+
95
+ We'll have documentation and an example soon for deploying to DigitalOcean.
96
+
78
97
### Contributing
79
98
80
99
This is still pre-v1 and API _ might_ change. All contributions highly appreciated,
81
100
please make sure to discuss before starting anything.
101
+
102
+ ### Roadmap
103
+
104
+ We've the following features in the pipeline:
105
+
106
+ 1 . ~ Serverless function would enable having some backend functions directly
107
+ runnable from the backend server.
108
+ 2 . Message Queueing system (this is related to having custom function running first)
109
+ 3 . Try to make StaticBackend as useful as possible aka listening to feedback
0 commit comments