From 6bd99d9a346d8af23911b73de011ea951c889661 Mon Sep 17 00:00:00 2001 From: Sebastien Castiel Date: Wed, 13 Dec 2023 12:31:36 -0500 Subject: [PATCH] Update README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 53ebe4e..02521ec 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,14 @@ Spliit is a free and open source alternative to Splitwise. I created it back in The project is open to contributions. Feel free to open an issue or even a pull-request! +## Run locally + +1. Clone the repository (or fork it if you intend to contribute) +2. `npm install` +3. Start a PostgreSQL server. You can run `./start-local-db.sh` if you don’t have a server already. +4. Copy the file `.env.example` as `.env` +5. `npm run dev` + ## License MIT, see [LICENSE](./LICENSE).