Add preparation and build instructions
2 files changed, 16 insertions, 2 deletions
diff --git a/DEPLOY.md b/DEPLOY.md
index 302edaa..a427ed7 100644
--- a/DEPLOY.md
+++ b/DEPLOY.md
@@ -28,9 +28,23 @@ services.safeNSound = {
## Other Linux distros:
+### Preparation
+
+Make sure you have the following installed:
+- Node.js (v22 or later)
+- MongoDB
+
+```shell
+git clone --recursive https://cgit.rory.gay/school/nodejs-final-assignment.git/
+cd nodejs-final-assignment
+npm i
+```
+
+### Installation
+
Please see your service manager:
- systemd (Debian, Arch, Fedora, ...): /etc/systemd/system/SafeNSound.service (see [example](https://cgit.rory.gay/school/nodejs-final-assignment.git/tree/doc/systemd.service))
-- sysvinit/openrc/... (Alpine, Gentoo, Devuan, ...): /etc/init.d/SafeNSound
+- Other: please refer to your service manager's documentation.
## General setup considerations:
- Do not run as root!
diff --git a/plan.md b/plan.md
index 3588bf8..cd93469 100644
--- a/plan.md
+++ b/plan.md
@@ -7,7 +7,7 @@
- [x] MongoDB CRUD operations and Mongoose modeling (with Joi validation)
- [ ] Complete data and input validation (including ObjectId validation)
- [x] Middleware functions
-- [ ] A detailed deployment step-by-step plan: the application must be deployed on a cloud server and publicly accessible
+- [x] A detailed deployment step-by-step plan: the application must be deployed on a cloud server and publicly accessible
- [x] REST Client API calls provided for all API endpoints
- [x] Comprehensive API documentation
|
