initial public commit

2022-07-07 00:19:05 +03:00
commit 3d07f0211d
484 changed files with 92412 additions and 0 deletions
@@ -0,0 +1,124 @@
+<p align="center">
+    <a href="https://pocketbase.io" target="_blank" rel="noopener">
+        <img src="https://i.imgur.com/ZfD4BHO.png" alt="PocketBase - open source backend in 1 file" />
+    </a>
+</p>
+
+<p align="center">
+    <a href="https://github.com/pocketbase/pocketbase/actions/workflows/release.yaml" target="_blank" rel="noopener"><img src="https://github.com/pocketbase/pocketbase/actions/workflows/release.yaml/badge.svg" alt="build" /></a>
+    <a href="https://github.com/pocketbase/pocketbase/releases" target="_blank" rel="noopener"><img src="https://img.shields.io/github/release/pocketbase/pocketbase.svg" alt="Latest releases" /></a>
+    <a href="https://pkg.go.dev/github.com/pocketbase/pocketbase" target="_blank" rel="noopener"><img src="https://godoc.org/github.com/ganigeorgiev/fexpr?status.svg" alt="Go package documentation" /></a>
+</p>
+
+[PocketBase](https://pocketbase.io) is an open source Go backend, consisting of:
+
+- embedded database (_SQLite_) with **realtime subscriptions**
+- backed-in **files and users management**
+- convenient **Admin dashboard UI**
+- and simple **REST-ish API**
+
+**For documentation and examples, please visit https://pocketbase.io/docs.**
+
+> ⚠️ Although the web API defintions are considered stable,
+> please keep in mind that PocketBase is still under active development
+> and therefore full backward compatibility is not guaranteed before reaching v1.0.0.
+
+
+## API SDK clients
+
+The easiest way to interact with the API is to use one of the official SDK clients:
+
+- **JavaScript - [pocketbase/js-sdk](https://github.com/pocketbase/js-sdk)** (_browser and node_)
+- **Dart** - _soon_
+
+
+## Overview
+
+PocketBase could be used as a standalone app or as a Go framework/toolkit that enables you to build
+your own custom app specific business logic and still have a single portable executable at the end.
+
+### Installation
+
+```sh
+# go 1.18+
+go get github.com/pocketbase/pocketbase
+```
+
+### Example
+
+```go
+package main
+
+import (
+    "log"
+    "net/http"
+
+    "github.com/labstack/echo/v5"
+    "github.com/pocketbase/pocketbase"
+    "github.com/pocketbase/pocketbase/apis"
+    "github.com/pocketbase/pocketbase/core"
+)
+
+func main() {
+    app := pocketbase.New()
+
+    app.OnBeforeServe().Add(func(e *core.ServeEvent) error {
+        // add new "GET /api/hello" route to the app router (echo)
+        e.Router.AddRoute(echo.Route{
+            Method: http.MethodGet,
+            Path:   "/api/hello",
+            Handler: func(c echo.Context) error {
+                return c.String(200, "Hello world!")
+            },
+            Middlewares: []echo.MiddlewareFunc{
+                apis.RequireAdminOrUserAuth(),
+            },
+        })
+
+        return nil
+    })
+
+    if err := app.Start(); err != nil {
+        log.Fatal(err)
+    }
+}
+```
+
+### Running and building
+
+Running/building the application is the same as for any other Go program, aka. just `go run` and `go build`.
+
+**PocketBase embeds SQLite, but doesn't require CGO.**
+
+If CGO is enabled, it will use [mattn/go-sqlite3](https://pkg.go.dev/github.com/mattn/go-sqlite3) driver, otherwise - [modernc.org/sqlite](https://pkg.go.dev/modernc.org/sqlite).
+
+Enable CGO only if you really need to squeeze the read/write query performance at the expense of complicating cross compilation.
+
+### Testing
+
+PocketBase comes with mixed bag of unit and integration tests.
+To run them, use the default `go test` command:
+```sh
+go test ./...
+```
+
+Check also the [Testing guide](http://pocketbase.io/docs/testing) to learn how to write your own custom application tests.
+
+## Security
+
+If you discover a security vulnerability within PocketBase, please send an e-mail to **support at pocketbase.io**.
+
+All reports will be promptly addressed and you'll be credited accordingly.
+
+
+## Contributing
+
+PocketBase is free and open source project licensed under the [MIT License](LICENSE.md).
+
+You could help continuing its development by:
+
+- [Suggest new features, report issues and fix bugs](https://github.com/pocketbase/pocketbase/issues)
+- [Donate a small amount](https://pocketbase.io/support-us)
+
+> Please also note that PocketBase was initially created to serve as a new backend for my other open source project - [Presentator](https://presentator.io) (see [#183](https://github.com/presentator/presentator/issues/183)),
+so all feature requests will be first aligned with what we need for Presentator v3.