LaTonia-Mertica / inheritance-artifacts

CU 'JTC' WOW Project Beyond MVP Accessible at Repo 'Inheritance'
MIT License
0 stars 0 forks source link
columbia-university inheritance-artifacts justice-through-code python-bootcamp wow-project

INHERITANCE DOT ARTIFACTS

note: upon arrival, the inheritance site/app appears broken. it is not. view it as a blank canvas on which you can author creative, unique outcomes for a session. .. unless and until we are able to dedicate time and energy needed to operate inheritance full time, the site/app is designed for single-session use - meaning you can visit the deploy, build out the content, and be the sole or shared author as long as the session continues. once done, the inheritance site resets


destined for existence as an app and/or online at https://inheritance.artifacts accompanied by tagline 'where life lives'

visit inheritance artifacts live demo

view inheritance dramatic intro video


PRIMARY WOW PROJECT COLLABORATORS

Jason Doze
GITHUB UN: Jason-Doze

La'Tonia Mertica Sheppard Walker
GITHUB UN: LaTonia-Mertica


MENTOR SUPPORT

couldn't have achieved the level we have without the stellar support of our mentors


view flow chart
view landing page wireframe
view gallery wireframe
view add artifact wireframe
view entity relationship diagram


HELPFUL SETUP INSTRUCTIONS & INSIGHT

for your own code safety, please be prudent about researching to meet your specific code needs



USE VENV TO CREATE & RUN VIRTUAL ENVIRONMENTS:

  1. Execute VENV Command to Create
    1a. Mac aka BASH/ZSH Users run python3 -m venv /path/to/new/virtual/environment
    1b. PC aka Windows Users run c:\>c:\Python35\python -m venv c:\path\to\myenv
    note: basically you want to run python3 -m venv django-env while replacing django-env appropriately

  2. Execute Activate Command
    2a. MAC aka BASH/ZSH Users run source django-env/bin/activate
    2b. PC aka Windows Users run django-env\Scripts\activate.bat and if it doesn't work run django-env\Scripts\activate.ps1

  3. Execute Run Server Command
    3a. Mac aka BASH/ZSH and PC aka Windows Users run python manage.py runserver from app level - which is the same level within the project that contains the manage.py file/utility to start Django server (more info below in the run django application instructions)

learn more re: creating and activating virtual environments


USE PIP TO INSTALL PROJECT DEPENDENCIES:

  1. if installing after cloning a repo, run pip install -r requirements.txt to execute the command to read the requirements file and install everything in it

  2. if pip is already installed and want to install a package, run pip install [insertpackagenamehere]
    2a. next run pip freeze > requirements.txt
    2b. this command creates a file called requirements.txt while populating the file with dependencies resulting from the install command in step 1 above. from the command line aka terminal run cat requirements.txt to view dependencies listed in the file

note: pip is the standard package manager for python. visit python package index to learn more about packages. the command pip install must be followed by the package you want to install. the command can be run to install the package with or without its dependencies

learn more re: pip install
learn more re: using pip to install project dependencies


RUN A DJANGO APPLICATION:

  1. You must use the manage.py file/utility to run the server. From the command line/terminal cd to the level where the manage.py file/utility lives. Run the command python manage.py runserver. You will know the command was successful when you see the following message (or something similar):

"Watching for file changes with StatReloader Performing system checks...

System check identified no issues (0 silenced). You have 17 unapplied migration(s). Your project may not work properly until you apply the migrations for app(s): admin, auth, contenttypes, sessions. Run 'python manage.py migrate' to apply them. May 17, 2019 - 16:09:28 Django version 2.2.1, using settings 'mysite.settings' Starting development server at http://127.0.0.1:8000/ Quit the server with CONTROL-C. "


Django App Launch Successful


note: the above message means the django application is running, you must visit the http://127.0.0.1:8000/ link to access the django application in browser. the django welcome/homepage may look like an error or exception. this is until you read what it says and follow the instructions to add url endpoints per your project into the browser. for example, http://127.0.0.1:8000/(insert your url endpoint here without including the parentheses).

visit us at trello for insight on general planning and organization


HOW INHERITANCE DOT ARTIFACTS WORKS

visit the pages, maybe even add your own artifact to the inheritance community - just please embrace the concept



Landing Page Screen

Landing Page establishes overall ambiance and navigation. It also, through SYMBOLIC RELEASE, demonstrates our elevated dedication to self-awareness, getting beyond barriers, and holistic health.

Our Story Page Screen

Our Story shares insight, intent, and sense of community at the heart of the creation of Inheritance.

Add Artifacts Page Screen

Add Artifact is the opportunity to consider what you will add to the story. In other words, what image and description you would submit as an artifact.

Gallery Page Screen

Gallery is a collection of the vibrancy of contributions through shared artifacts.

NEXT STEPS