diff options
| author | Max <Max-TheCat@users.noreply.github.com> | 2024-01-11 15:25:08 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-01-11 15:25:08 -0500 |
| commit | 76427c9f130adb90f90cccc84b92dd49f5147ed5 (patch) | |
| tree | 5e1ac61ffaff7040e3b85a98cee9f4fd11dac54a /README.md | |
| parent | ddce4d0bdbf657de1bf11ce2722ed0435868e41d (diff) | |
Docker container version (#39)
* + 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>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 8 |
1 files changed, 7 insertions, 1 deletions
@@ -35,10 +35,16 @@ The project is open to contributions. Feel free to open an issue or even a pull- 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. +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). |