diff options
| author | Sebastien Castiel <sebastien@castiel.me> | 2023-12-13 12:31:36 -0500 |
|---|---|---|
| committer | Sebastien Castiel <sebastien@castiel.me> | 2023-12-13 12:31:36 -0500 |
| commit | 6bd99d9a346d8af23911b73de011ea951c889661 (patch) | |
| tree | 100f38ea21e0b04ca083e02ff130f4b85ca2a7ca | |
| parent | c96c4f94b93b5961b2787f980417bd2df92812e5 (diff) | |
Update README
| -rw-r--r-- | README.md | 8 |
1 files changed, 8 insertions, 0 deletions
@@ -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). |