Basic Features

1. Login & Registration with User Session Handle
2. Search Certain Apartment Unit
3. Register Pets
4. Post and View Interests
5. Display Unit and Building Info

Additional Features

6. Advanced Search of Units
7. Search Interest
8. Estimate Monthly Rent
9. Favourite
10. Extra View on the Rent Price
11. Comment System

Application Related Features

12. Sessions
13. Necessary Security Mechanism

Commands to run:

1. To install the dependencies, open two separate terminals (one in the "backend" directory and the other in the "frontend" directory):

In the backend terminal run:

pip install -r requirements.txt

In the frontend terminal run:

npm install

2. Use mysqldump to export your database to a SQL file. This file will contain the SQL commands to recreate the database structure and insert the data. Replace username and target_database with your local MySQL credentials and also update .env with your database name, username, password and port name.

mysql -u username -p target_database < path/to/roomie.sql

OR (for Windows)

Get-Content roomie.sql | ./mysql -u root -p roomie

3. In your terminal, navigate to your project directory. Run the following commands to apply initial database migrations:

python manage.py makemigrations

python manage.py migrate

4. To get the server/client up and running, run the following command:

In the backend terminal:

python3 manage.py runserver

In the frontend terminal:

npm start

5. You should see a message indicating the server is running, and you can visit http://127.0.0.1:8000 in your web browser to see the default Django welcome page.

6. To save your database changes in mysql before commiting and pushing to git

.\mysqldump -u username -p target_database > roomie.sql