mirror of
https://github.com/spliit-app/spliit.git
synced 2026-02-17 21:16:14 +01:00
76427c9f13
* + Dockerfile and compose file + Scripts dir and startup script + Build image npm script * * Moves env to file * + Tags image with info from package.json * Moves image creation to script * Updates README * Update README.md Co-authored-by: Sebastien Castiel <sebastien@castiel.me> --------- Co-authored-by: Maxime Jacob <mjacob-no-reply@proton.me> Co-authored-by: Sebastien Castiel <sebastien@castiel.me>
51 lines
2.0 KiB
Markdown
51 lines
2.0 KiB
Markdown
[<img alt="Spliit" height="60" src="https://github.com/scastiel/spliit2/blob/main/public/logo-with-text.png?raw=true" />](https://spliit.app)
|
||
|
||
Spliit is a free and open source alternative to Splitwise. I created it back in 2022 as a side project to learn the Go language, but rewrote it with Next.js since.
|
||
|
||
## Features
|
||
|
||
- [x] Create a group and share it with friends
|
||
- [x] Create expenses with description
|
||
- [x] Display group balances
|
||
- [x] Create reimbursement expenses
|
||
- [x] Progressive Web App
|
||
- [x] Select all/no participant for expenses
|
||
- [x] Split expenses unevenly [(#6)](https://github.com/scastiel/spliit2/issues/6)
|
||
- [x] Mark a group as favorite [(#29)](https://github.com/scastiel/spliit2/issues/29)
|
||
- [x] Tell the application who you are when opening a group [(#7)](https://github.com/scastiel/spliit2/issues/7)
|
||
|
||
### Possible incoming features
|
||
|
||
- [ ] Ability to create recurring expenses [(#5)](https://github.com/scastiel/spliit2/issues/5)
|
||
- [ ] Import expenses from Splitwise [(#22)](https://github.com/scastiel/spliit2/issues/22)
|
||
|
||
## Stack
|
||
|
||
- [Next.js](https://nextjs.org/) for the web application
|
||
- [TailwindCSS](https://tailwindcss.com/) for the styling
|
||
- [shadcn/UI](https://ui.shadcn.com/) for the UI components
|
||
- [Prisma](https://prisma.io) to access the database
|
||
- [Vercel](https://vercel.com/) for hosting (application and database)
|
||
|
||
## Contribute
|
||
|
||
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 `./scripts/start-local-db.sh` if you don’t have a server already.
|
||
4. Copy the file `.env.example` as `.env`
|
||
5. `npm run dev`
|
||
|
||
## Run in a container
|
||
1. Run `npm run build-image` to build the docker image from the Dockerfile
|
||
2. Copy the file `container.env.example` as `container.env`
|
||
3. Run `npm run start-container` to start the postgres and the spliit2 containers
|
||
3. You can access the app by browsing to http://localhost:3000
|
||
|
||
## License
|
||
|
||
MIT, see [LICENSE](./LICENSE).
|