summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAhmed Abdelhalim <[email protected]>2023-07-30 16:12:29 +0200
committerAhmed Abdelhalim <[email protected]>2023-07-30 16:12:29 +0200
commit02fefc48afe713a1f03720cdfb22f438f7b97c0e (patch)
tree34b1f7f292cda2304374c79a050ce6b5f6ab1912 /README.md
parent7c78c839c25f8685020749761d46aab6e488b049 (diff)
Add docker development support
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 17 insertions, 5 deletions
diff --git a/README.md b/README.md
index c61592e..e850d32 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,29 @@
-# Prerequisites :
+# Local
+## Prerequisites :
- Node v12 (or higher): `brew install node`
- Yarn: `brew install yarn`
-# Installation :
+## Installation :
- Clone the repo.
- Run `yarn install`
-# Development :
+## Development :
- Run `yarn start`
-# Build :
+## Build :
- Run `yarn build`
-# Deploy :
+## Deploy :
- Run `yarn build`
- Copy the generated `public` directory to any hosting environment. (`srht.site`)
+
+# Docker
+## Prerequisites:
+- Docker: `brew install docker`
+
+## Build
+- Run `docker build . -t website`
+- Run `docker run -p 3333:3333 -it website`
+or
+- Run `docker-compose build`
+- Run `docker-compose up`