mirrors/spliit
1
0
Fork 0
mirror of https://github.com/spliit-app/spliit.git synced 2026-03-05 12:16:13 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Sebastien Castiel
2023-12-13 12:31:36 -05:00
parent c96c4f94b9
commit 6bd99d9a34
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -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! 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 ## License
MIT, see [LICENSE](./LICENSE). MIT, see [LICENSE](./LICENSE).