added a read me file

jamiebones · Oct 28, 2024 · 4a8ccda · 4a8ccda
1 parent fecdc04
commit 4a8ccda
Show file tree

Hide file tree

Showing 8 changed files with 33,393 additions and 14 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -3,4 +3,4 @@
 /server/logs
 .git
 .gitignore
-docker-compose*
+docker-compose*
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,6 @@ node_modules
 node_modules
 .git
 .dockerignore
+docker-compose-backup.yml
+docker-compose.yml
+docker-compose-prod.yml
diff --git a/Readme.md b/Readme.md
@@ -0,0 +1,21 @@
+# Hostel Allocation Software
+
+## Description:
+
+This is an application created to manage and allocate hostel spaces to students of University of Uyo. The application was created using the following technologies:
+* NODEJS
+* React
+* MongoDB
+* Redis 
+* Docker
+* Docker-Compose
+
+## Getting Started:
+
+Install Docker and Docker-Compose on your development machine. 
+
+To build and start the project run: 
+>  docker compose -f "docker-compose-dev.yml" up -d --build 
+
+
+