HMC/cactoide
2
0
Fork 0
forked from jmug/cactoide
Code Pull Requests Activity

add healthz, docker fixes, minor readme tweaks

Browse Source
This commit is contained in:
Nandor Magyar
2025-08-31 15:55:44 +02:00
committed by Levente Orban
parent cc8266ae6e
commit 94fffc5695
6 changed files with 41 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -27,10 +27,23 @@ A mobile-first event RSVP platform that lets you create events, share unique URL
### Quick Start
Requirements: git, docker, docker-compose
Uses the [`docker-compose.yml`](docker-compose.yml) file to setup the application with the database. You can define all ENV variables in the [`.env`](.env.example) file from the `.env.example`.
```bash
git clone https://github.com/polaroi8d/cactoide/
cd cactoide
cp env.example .env
docker compose up -d
```
### Development
Requirements: git, docker, docker-compose, node at least suggested 20.19.0
```bash
git clone https://github.com/polaroi8d/cactoide/
cd cactoide
npm install
cp env.example .env
make db-only
npm run dev -- --open
@@ -38,10 +51,6 @@ npm run dev -- --open
Your app will be available at `http://localhost:5173`. You can use the Makefile commands to run the application or the database, eg.: `make db-only`.
### Self-Host
Use the [`docker-compose.yml`](docker-compose.yml) file to setup the application with the database. You can define all ENV variables in the [`.env`](.env.example) file from the `.env.example`.
### License
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.