A work in progress.
Let's not sugar coat it, it's a Zillow/Apartments.com/StreetEasy clone built for practice and demonstration purposes. Renter is a Vue SPA powered by a Django API and backend.
Started with and now influencing the design of my fullstack scaffolding template.
I followed most of the standard Django recommendations during setup. This was augmented by some things I've picked up during my career like Django REST Framework, factory-boy dummy data, code formatting, etc.
Vue. TypeScript. SCSS. Bootstrap. Simple enough. I've included linting powered by ESLint and Stylelint. I'd highly encourage installing the VS Code Extensions for these packages, otherwise be sure the files are linted before committing.
- Ensure Python is installed on your machine
- Activate the virtual environment. Shown here on Windows:
> python -m venv venv
> /venv/Scripts/activate
- Install monorepo dependencies
> pip install -r requirements.txt
- (Optional) Install
pre-commithooks. Pre-commit is added to the dev containers if you would like to use it there instead.
> pre-commit install
Assuming Docker is already installed.
- Build and start the containers
> cd path/to/renter
> docker compose --profile fullstack up -d
Once the container is created, you'll need to start Django.
- SSH into the
backendcontainer (or attach VS Code to it)
> docker compose exec backend /bin/bash
- Activate the virtual environment
> source activate
- Set up the database
> python manage.py migrate
- Populate the database with dummy data
> python manage.py setup_data
- Start the server. The
0.0.0.0:8000is required to communicate with Docker.
> python manage.py runserver 0.0.0.0:8000
- SSH into the
frontendcontainer (or attach VS Code to it)
> docker compose exec frontend /bin/bash
- Start the server
> npm run dev
- Navigate to http://localhost:3000