summaryrefslogtreecommitdiff
path: root/server/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'server/README.md')
-rw-r--r--server/README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/server/README.md b/server/README.md
new file mode 100644
index 0000000..18ac0be
--- /dev/null
+++ b/server/README.md
@@ -0,0 +1,31 @@
+# Save server
+
+## Requirements
+
+- `nodejs` (recent)
+- `npm`/`yarn`
+
+## Docs
+
+### CLI
+
+- `node index register`: register user
+
+### Endpoints
+
+- POST `/login` `body{<username>, <password>}` =\> `.token`: generate
+ access token
+- POST `/text` `header{<token>}` `body{<data>}`: upload text data
+- POST `/file` `header{<token>}` `files{<file>}`: upload file
+- GET `/file/<token>` `header{<token>}` =\> `<file>`: download file
+ using token
+- GET `/saved` `header{<token>}` =\> `{{<file>}, {<text>}}`: list all
+ files/texts
+
+## Installation
+
+- edit `.env` file: `$EDITOR .env`
+- install dependencies: `npm i`
+- register user: `node index register`
+- start server: `node index`
+- configure one of the clients