Django Contact Keeper

Contact Keeper is an application built with Django. This is a full stack application that allows a user to register and create contacts with phone and email info, as well as filter those contacts. This project is a Django adaptation of Brad Traversy's React Contact Keeper, taken from his React Front to Back Udemy course.

Demo login credentials: Username: testUser Password: 123test123

Running the project locally

• Clone or download the repo (e.g, gh repo clone aemann2/contact_keeper)
• Place the cloned repo in a directory. I call mine django_contact_keeper
• In the directory containing the cloned repo, up a virtual environment using python -m venv venv
• Activate the virtual environment using . venv/bin/activate with bash, or using source venv/bin/activate with zsh
• Navigate into the main contact_keeper directory downloaded from the repo
• In contact_keeper, install the project dependencies using pip install -r requirements.txt
• Follow the directions here to set up a Postgres database locally
• In the main contact_keeper directory, run python manage.py migrate and python manage.py collectstatic
• Navigate to the src directory and create a file called .env. Populate this file with the values used to set up your Postgres database. Make sure DEBUG is set to TRUE.
• In the main contact_keeper directory, run python manage.py runserver to run the project locally

Technology:

Python, Django, SASS, Bootstrap, HTMX, Coverage (for testing), Postgres, Heroku

Commands for running tests w/ coverage:

• Run test suite: coverage run --source='.' manage.py test
• Building HTML page for coverage results: coverage html