Update the README

This commit is contained in:
Karl Cordes 2025-06-03 07:49:29 +10:00
parent 6ad0e74ad6
commit a45effbd2b

View file

@ -1,7 +1,26 @@
# cmc-sales
## Development Docker compose instructions
## Install
``` shell
git clone git@code.springupsoftware.com:cmc/cmc-sales.git
cd cmc-sales
rsync -avz --progress cmc@sales.cmctechnologies.com.au:~/backups .
docker compose up
# DB password is in config/database.php because..reasons.
# TODO move it to an environment var and rotate it..
gunzip < backups/backup_*.sql.gz | mariadb -h 127.0.0.1 -u cmc -p cmc
# edit your dev machine /etc/hosts and add
127.0.0.1 cmclocal
# open up cmclocal in your browser.. hopefully it'll work.
```
## Install a new server
(TODO this is all likely out of date)
### Requirements