A simple website for Renters to rate their Landlord
Copy the .env.example in a new .env file.
If you are working with the backend, make sure you have that forked and setup
first so you can pass the url to the .env file.
Set the environment to development
This project uses Bun for package management. To install Bun on your machine, please check Here
Then run the following commands:
-
Install Packages
bun install -
Start Dev Mode
bun dev
The project should not be running at http://localhost:3000 and pick up changes
you make in you IDE
Download pgAdmin4 - https://www.postgresql.org/download/
Install and complete the setup process.
REMEMBER THE PASSWORD YOU SET DURING THE INSTALL PROCESS!
Open PgAdmin 4 in your web browser.
In the left sidebar, navigate to "Servers" and expand your PostgreSQL server.
Right-click on "Databases" and choose "Create > Database."
In the "Database" tab, provide a name for your new database. You can also configure other settings such as the owner, encoding, and template if needed.
Click the "Save" button to create the new database.
In the left sidebar, under "Servers," find and expand your PostgreSQL server.
Right-click on "Databases" and choose "Refresh" to make sure the new database appears.
Right-click on the newly created database and choose "Connect."
After connecting to the database, you can find the connection string details in PgAdmin 4.
Right-click on the database in the left sidebar, select "Properties," and go to the "Connection" tab.
On the "Connection" tab, you'll see various details, including the connection string. The connection string typically looks like:
Copy code
postgresql://username:password@host:port/database_name
Replace username with your PostgreSQL username.
Replace password with your PostgreSQL password.
Replace host with the address where PostgreSQL is running.
Replace port with the port number (default is 5432).
Replace database_name with the name of your newly created database.
Step 4: Use Connection String
You can use the obtained connection string in your applications, scripts, or tools that require a PostgreSQL connection. Replace the placeholders with your actual credentials and connection details.
For example:
plaintext
Copy code
postgresql://myuser:mypassword@localhost:5432/mydatabase
Make sure to secure your credentials and use appropriate connection methods based on the security requirements of your application.
Remember to adjust the connection details based on your specific setup and configuration. If you encounter any issues, double-check your PostgreSQL server settings, firewall rules, and authentication configurations.
You can also create a database with a service like Supabase and use the connection string from there. The service is free.
Run "npm run migrate:up" in order to create the necessary tables in your postgres instance.
Create an account with Auth0 and follow their setup process. It's free and will allow you to test admin functionality.
You will need to create an ADMIN role (upper case important), and assign it to your user. You will then need to insert a custom action into the login flow to add this role claim.
exports.onExecutePostLogin = async (event, api) => {
if (event.authorization) {
api.idToken.setCustomClaim(`role`, event.authorization.roles[0]);
api.accessToken.setCustomClaim(`role`, event.authorization.roles[0]);
}
}
You can read an example here
If you are trying to submit a review locally, you will need to set up recaptcha on google, and populate the .env file with the values.
You will also need to edit your hosts file to allow Captcha to work. Follow These guides:
This project uses Husky to run a pre-commit check to make sure the project passes tests and linting. It also formats the files to prettier standard we have set.
If it fails, then there is a chance that your changes have linting errors, or broke some tests.
You may get this error: /usr/bin/env: ‘sh\r’: No such file or directory
If you encounter this error, you'll need to install dos2unix in your terminal.
Then run sudo dos2unix .husky/pre-commit.
Contributions are always welcome!
See contributing.md for ways to get started.
Please adhere to this project's code of conduct.