A web application that aims to streamline the dorm packing and planning process.

DormDesign allows roommates to collaboratively design and plan our their dorm room. Users can keep track of different items and position them in the room using the editor. All actions are updated and displayed to all users viewing the room in realtime.

Key Features

• Claim and keep track of items
• Position items inside of a to-scale floor plan of the room
• Create rooms from pre-defined templates
• Changes are synced in realtime

Screenshots

Development Environment

1. Install docker and docker-compose
2. Clone repository
3. Navigate to the /frontend folder and run npm install
4. In the root directory, create a file called .env with the following content: REDIS_PASSWORD=<some password here>
   • This ensures that the cache is password-protected and not accesible to external connections
5. Then from the root of the project directory run npm run dev (if this fails, try running sudo docker-compose --env-file ./.env -f docker-compose.dev.yml up --build) to start the server.

Deployment

Steps for setting up server from scratch (only needs to be done once):

1. Install docker and docker-compose
2. Clone repository
3. Navigate to the root of the project directory and run sudo chmod +x ./init-letsencrypt.sh
4. Run sudo ./init-letsencrypt.sh

How to start production server

Make sure that you have your .env file set up to look like this:

REDIS_PASSWORD=<some password here>
MONGO_ADDRESS=<your-mongo-db-address>

The MongoDB address should be assigned to the address of your local MongoDB instance (assuming that you're hosting your own MongoDB instance) or your MongoDB Atlas URL.

Then, run docker-compose --env-file ./.env up --build -d. Similar to the development environment, it may be necessary to run this command using sudo.

Database Migrations

Anytime the internal structure of a document stored in the database is changed, the existing documents need to be updated to match. Currently, we use migrate-mongo to perform these migrations (click the link to view more information on how that package works).

Document schema versions are specified by the schemaVersion field (which should be manually incremented anytime the schema is changed)

Shortcut scripts have been added to the package.json in the project root folder:

npm run migrate:up - Run all unapplied DB migrations

npm run migrate:down - Undo last applied migration

npm run migrate:status - View status of all migrations

If MONGO_ADDRESS is set in the .env file, then the migrations will be applied to the database instance at that address. Otherwise, it defaults to the address of the local development database (mongodb://localhost:27017).

IMPORTANT: It's intended that production database migrations are only applied from the production server (where the production MONGO_ADDRESS should be set). Also the production API server shouldn't be live while these migrations are being applied since users accessing and modifying the data could interfere with the migration process.