feat: initial public version

2023-11-25 04:02:45 +05:00
parent ebd1d47fc6
commit 8447197d0f
64 changed files with 3880 additions and 4 deletions
--- a/README.md
+++ b/README.md
@@ -1,2 +1,97 @@
-# codapi
-Embeddable code playgrounds.
+# Embeddable code playgrounds
+
+> For education, documentation, and fun.
+
+Codapi is a platform for embedding interactive code snippets directly into your product documentation, online course, or blog post.
+
+```
+  python
+┌───────────────────────────────┐
+│ msg = "Hello, World!"         │
+│ print(msg)                    │
+│                               │
+│                               │
+│ run ►                         │
+└───────────────────────────────┘
+  ✓ took 387 ms
+┌───────────────────────────────┐
+│ Hello, World!                 │
+└───────────────────────────────┘
+```
+
+Codapi manages sandboxes (isolated execution environments) and provides an API to execute code in these sandboxes. It also provides a JavaScript widget [codapi-js](https://github.com/nalgeon/codapi-js) for easier integration.
+
+Highlights:
+
+-   Supports dozens of playgrounds out of the box, plus custom sandboxes if you need them.
+-   Available as a cloud service and as a self-hosted version.
+-   Open source. Uses the AGPL license. Committed to remaining open source forever.
+-   Lightweight and easy to integrate.
+
+Learn more at [**codapi.org**](https://codapi.org/)
+
+## Installation
+
+See [Installing Codapi](docs/install.md) for details.
+
+## Usage (API)
+
+Call `/v1/exec` to run the code in a sandbox:
+
+```http
+POST https://api.codapi.org/v1/exec
+content-type: application/json
+
+{
+    "sandbox": "python",
+    "command": "run",
+    "files": {
+        "": "print('hello world')"
+    }
+}
+```
+
+`sandbox` is the name of the pre-configured sandbox, and `command` is the name of a command supported by that sandbox. See [Configuration](docs/config.md) for details.
+
+`files` is a map, where the key is a filename and the value is its contents. When executing a single file, it should either be named as the `command` expects, or be an empty string (as in the example above).
+
+Response:
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+```
+
+-   `id` is the unique execution identifier.
+-   `ok` is `true` if the code executed without errors, or `false` otherwise.
+-   `duration` is the execution time in milliseconds.
+-   `stdout` is what the code printed to the standard output.
+-   `stderr` is what the code printed to the standard error, or a compiler/os error (if any).
+
+## Usage (JavaScript)
+
+See [codapi-js](https://github.com/nalgeon/codapi-js) to embed the JavaScript widget into a web page. The widget uses exactly the same API as described above.
+
+## Contributing
+
+Pull requests are welcome. For new features or improvements, please first open an issue to discuss what you would like to change.
+
+Be sure to add or update tests as appropriate.
+
+## License
+
+Copyright 2023+ [Anton Zhiyanov](https://antonz.org/).
+
+The software is available under the AGPL License.
+
+## Stay tuned
+
+[**★ Subscribe**](https://antonz.org/subscribe/) to stay on top of new features.
+Copyright 2023+ [Anton Zhiyanov](https://antonz.org/).
+
+The software is available under the AGPL License.
+
+## Stay tuned
+
+[**★ Subscribe**](https://antonz.org/subscribe/) to stay on top of new features.