nicholas/storage-manager#1: Update README.md

README.md

@@ -1,21 +1,54 @@
-# storage
-#### purpose
+# storage-manager
+
+## purpose
 This project is supposed to make finding objects inside boxes easier. Translucent storage boxes are ugly. Over time and with the addition of new items, labels become irrelevant to the items they are meant to describe. They are inflexible. Distinctions between which box an item belongs can be arbitrary and confusing. e.g. Scissors belonging to 'Tools' or 'Crafts'.
-#### features: 
+
+## features: 
 - Record physical location, quantity, description, etc of items
 - Search by item/box name, description
 - Move items to and from boxes
-- Categorize boxes by color
-#### requirements
+
+## Stack
 - mongodb
 - node.js
-#### development environment
-/server/
-- `npm i`
-- `MONGO_IP_ADDRESS` change to mongodb host address
-- create mongodb database named `storage`
-- `npm run start`
+- Vite
+- Typescript
+- TailwindCSS
 
-/client/
+## Dev Environment
+### Database
+Located in `database` directory. Configured to use Mongo DB Docker container `mongo-db`. Included is a `docker-compose.yml` file that will host a Mongo DB on port `27017` using credentials configured with environment variables, e.g:
+
+```env
+MONGO_INITDB_ROOT_USERNAME=<root username>
+MONGO_INITDB_ROOT_PASSWORD=<root password>
+ME_CONFIG_MONGODB_ADMINUSERNAME=<mongodb username>
+ME_CONFIG_MONGODB_ADMINPASSWORD=<mongodb admin password>
+```
+Also includes Mongo Express container `mongo-express`.
+
+---
+
+### Server
+Located in `server` directory. 
+- Edit `.env` file with credentials for database, e.g:
+
+```env
+DB_USERNAME=<username>
+DB_PASSWORD=<password>
+DB_HOST=<hostname> //server
+DB_PORT=<db port> //27017
+PORT=<server port> //5000
+```
+
+- Run `npm i` to install required node packages
+- Run `npm run start` to start server, uses `nodemon` to watch for server changes and restart server automatically.
+
+---
+
+### Client
+Located in `client/` directory.
 - `npm i`
-- `npm run start`
+- Uses `vite` build and dev server, `npm run dev`
+
+---