From f173c9823397696e644eea93217571a15968b92e Mon Sep 17 00:00:00 2001 From: Euan R Date: Fri, 12 Dec 2025 13:46:40 -0500 Subject: [PATCH] better readme Added features list and instructions for running the project. --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 463c17c..37d5180 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,17 @@ -everything stickers by Nora and Euan -Ruby with Grape + Svelte +everything stickers by Nora and Euan. + +Features: + -trade stickers + -see an archive of existing stickers + -vote for sticker designs + -use as an api for sticker designs + +Frontend in svelte, backend in Ruby with Grape. + +To run: +- copy .env.example and make a real .env file with appropriate keys/tokens +- npm install +- npm run dev +- cd backend +- bundle exec rackup config.ru -p 9292 -npm run dev \ No newline at end of file