mirror-mirror-WOW 🪞🪞🪞

Table of Contents 📖

• Description
• User Story
• Usage
• Credits
• Live Site
• WireFrame
• Demo Walk-through Video
• Mirror-Mirror Engineers
• Screenshots
• Technology-Used

Description:

🪞Mirror, Mirror🪞 is a CRUD (Create, Read, Update, Delete), user friendly application that is geared towards mental health and overall-wellness.

The goal of 🪞Mirror, Mirror🪞 is to allow the user that they are not alone and to empower the user to seek the help they need as well as provide resources on a local and national level. The app includes the ACE Quiz which is a quiz to see how childhood trauma impacts ones lives as well as the predisposed disposition towards incarceration.

The categories covered in 🪞Mirror, Mirror 🪞: Mental Health, Justice Impacted Information, Local and National Resources, Over-All Wellness, Physical Health, as well as the ability to allow the user to leave a comment and leave a review of not only the website but also the resources too.

User Story

As a person navigating life and the stressors in which each of us faces, but handle very differently. I want to be able to access local and national resources to assist in being proactive in my own mental health wellness and self care.

Usage

To use 🪞Mirror-Mirror 🪞

Clone the repository from Github

Clone the repository from Github into a directory.

  git clone <repository> <path>

---

Setting up the Virtual Environment

Now create a new virtual environment.

Run the following command:

  python -m venv venv  # you may have to use python3 instead of python

Activate the virtual environment.

Run one of the following commands depending on the type of operating system you are using:

MacOS, Linux, ChromeOS:
source venv/bin/activate
Windows:
venv\Scripts\activate.bat

---

Install Project Dependencies

Install the project dependencies.

Navigate to the project root directory.

Run the following commands:

  pip install django

  pip freeze install

  pip freeze > requirements.txt

---

Running the Application

Navigate to the mirror-mirror directory.

Run the following command:

  python manage.py runserver
  # you may have to replace python with python3

Point your browser to use the app: http://localhost:8000

---

Stopping the Application

Shut down the server.

Run the following command in the terminal:

  Ctrl+C

---

Exiting the Virtual Environment

Run the following command:

  deactivate

Technology used

• Bootstrap
• Javascript
• HTML
• CSS
• VS Code
• GitHub
• Miro

Additionally:

• Python data structures such as Lists, Dictionaries and their associated methods
• Python Classes and Inheritance
• Django URLs to understand how to capture parameters in views
• Django Templates
• Django Migrations
• Django Models
• Django Shell
• Django Post Create Content
• Django Static CSS
• Django HTML

---

Mirror-Mirror Engineers👑

• Asha Maurya👑
• Mianta McKnight👑
• Sierra Nash👑

Screenshots

Live Site🪞

Mirror-Mirror

WireFrame

WireFrame

Credits

Images used for Mirror-Mirror obtained through Unsplash and Pexels

ACE Quiz stats and resources obtained through Kaiser Permanente

NOTE: We are taking no additional collaborations at this time.

© 2022 Asha Maurya 👩🏿‍💻, Mianta McKnight 👩🏿‍💻, and Sierra Nash 👩🏿‍💻 🔥 Queens of Code V2 🔥 | All rights reserved |