Biome is a web app for all your LA housing needs! Built using the MERN stack for the CS 35L final project at UCLA. Check out the deployed app here: https://biome-cs35l.netlify.app/.
To run locally, first clone the repository to your local device. Then, to install all necessary dependencies/any new dependencies since the last commit, you can use npm run install-all.
To update all dependencies, you can use npm run update.
Run on a local server with npm run dev, which will start the development server at the port specified by REACT_APP_PORT in client/.env and a Node server at the port specified by PORT in server/.env.
You'll need two create these two .env files yourself if you want to run with your own data. Also, you'll need to create a Mongo account, as well as create a project, in which you'll create a Mongo Atlas Cluster with a database that contains 2 collections named listings and users. You'll also need to set up a Mongo Realm App to utilize user authentication.
The .env file in the client directory should be of the format:
REACT_APP_PORT=3001
REACT_APP_REALM_APP_ID=app-id
where REACT_APP_PORT is a port of your choice that the Node server (not your React development server) is running on and REACT_APP_REALM_APP_ID is the Mongo Realm App Id.
The .env file in the server directory should be of the format:
DB="mongodb+srv://admin:<password>@<cluster-id>.mongodb.net/<database-name>?retryWrites=true&w=majority"
PORT="3001"
where PORT is the same port as the client/.env REACT_APP_PORT, since this is the port the Node server is running on, and DB is the link to connect to your Mongo Atlas Cluster (linked above).