00 Set up

Prerequisites¶

To run Review-Master, you need the following installed on your system:

Python (latest version)
Homebrew (for macOS users)
PostgreSQL (version 14)

Getting Started¶

Step 1: Fork and Clone the Repository¶

Fork this repository on GitHub to make your own copy.

Clone the repository to your local machine:

git clone https://github.com/ilong4rennes/review-master.git
cd review-master

Step 2: Install Python and Virtual Environment¶

Install Python (if not already installed):
```
brew install python
```

Note: pip, Python’s package manager, will be installed automatically.

Install Virtualenv (if not already installed):
```
pip3 install virtualenv
```

Step 3: Install and Configure PostgreSQL¶

Install PostgreSQL 14:
```
brew install postgresql@14
```
Start the PostgreSQL service:
```
brew services start postgresql@14
```
Create a PostgreSQL Database and User:
Open the PostgreSQL interactive terminal:
```
psql postgres
```

Run the following commands in the terminal to set up your database and user:

CREATE DATABASE mydb;
CREATE USER myuser WITH PASSWORD 'mypassword';
ALTER ROLE myuser SET client_encoding TO 'utf8';
ALTER ROLE myuser SET default_transaction_isolation TO 'read committed';
ALTER ROLE myuser SET timezone TO 'UTC';
GRANT ALL PRIVILEGES ON DATABASE mydb TO myuser;

Exit the PostgreSQL terminal by typing \q.

Step 4: Set Up the Django Project¶

Create and Activate a Virtual Environment:

virtualenv venv
source venv/bin/activate

Install the Required Dependencies:
```
pip install -r requirements.txt
```
Configure the Database Settings:
In the Django project directory, open settings.py.

Update the database configuration to match the PostgreSQL setup:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': 'mydb',
        'USER': 'myuser',
        'PASSWORD': 'mypassword',
        'HOST': 'localhost',
        'PORT': '',
    }
}

Run Database Migrations:

python manage.py makemigrations
python manage.py migrate

Step 5: Run the Django Development Server¶

Start the server:
```
python manage.py runserver
```
Open a browser and navigate to http://127.0.0.1:8000 to view the application.

Troubleshooting¶

If you encounter any issues: - Ensure PostgreSQL is running by typing brew services list. - Verify that the database credentials in settings.py are correct. - Check for missing dependencies by re-running pip install -r requirements.txt.

License¶

This project is licensed under the MIT License.

This completes the setup for Review-Master. Enjoy exploring your Yelp-like web application!