aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 9 insertions, 14 deletions
diff --git a/README.md b/README.md
index 375e724..975962f 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,15 @@
### Scale
-This is scale webapp made using astro, its faster and better, because i know what i am doing this time. Its just better.
+This the scale project. This is the frotend of a simple image board.
+You can find the API [here](https://git.batnako.net/scale-api.git/).
-### Build
+### Build and Run
-To build and run see `run.sh`.
+For development I use: `NODE_TLS_REJECT_UNAUTHORIZED=0 DEV=1 npm run dev`
+To delpoy it with docker: `docker-compose up scale`
-For deploying only the `dist/` directory (genereted by `npm run build`)
-is needed and the 'server.mjs' file.
-Using the nodejs command in `run.sh`.
+### What can it do?
-Note: When running with node the image saving wont work properly
-because of different directories with images.
-
-### What can it do
-
-It can do whatever the
-[scale app made with svelte](https://gitlab.com/scale-project/scale)
-can, but faster and better, for info about the project see its readme.
+You can post images and text into threads and comments, and quote other people.
+It is a image board, what did you expect?
+It uses Astro and NodeJS for server-side rendering.