Rate The Landlord

A simple website for Renter's to rate their Landlord

Getting Started

Make sure you have Docker Desktop Installed

Copy the .env.example in a new .env file.

Set the environment to development

Then run the following commands:

• Install Packages cd frontend && npm i && cd ../backend && npm i

• Start docker-compose -f docker-compose.dev.yml up -d --build

The project should not be running at http://localhost and pick up changes you make in you IDE

Load the Database with Dummy Reviews

Make sure your docker environment is running.

• Get the CONTAINER ID of the postgres container with the command docker ps
• Make sure the permissions are set correctly with sudo chmod +x load-database.sh
• Run the script with command ./load-database.sh
• You will be prompted for the CONTAINER ID, postgres username (this is set in your .env file, and the number of rows you wish to populate)

Your database should now be loaded. Run this command as much as your wish.

Troubleshooting

Captcha Not Working

If you are trying to submit a review locally, you need to edit your hosts file to allow Captcha to work. Follow These guides:

• Hcaptcha Local Development

• Editing a Hosts file on Windows

ESLint Parsing Error with JetBrains IDE in WSL

• How to use WSL development environment in WebStorm

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.