PiTCRU

Screenshots

Home Page

About

Sign Up Form

Login Page

Car Index

List of Technologies Used

API Ninjas, bs4 (Beautiful Soup) , Django, Postgres, Neon, HTML, Python, CSS, Heroku, Python, Javascript, HTML, CSS, PostgreSQL, Django,

Unsolved Problems and Development Hurdles

Thankfully there were only a few obstacles we encountered mainly with our static assets and the forms pages, which still remains unsolved. Other obstacles that we overcame were synching out database and api content on the screen.

Prep Materials

Pitch Deck

https://docs.google.com/presentation/d/1qpX5GW_Bafp2oBqJjIH_7ISXsjz8pVqTMe-U6UNrceg/edit#slide=id.p

Trello Board

https://trello.com/invite/b/ZwKB3WGc/ATTI825093ffdfe208138f2e6222500dcc912ADDC12A/pitcru

Wireframes

ERD

How we git

Feature Branch Workflow

We implement a feature branch workflow, the rules of which include:

• All development work by a team member will be completed in a descriptively named feature branch
• Development work will only be added to the main project through branch merge pull requests
• All discussion and decision making will be tracked in pull request comments

Instructions

1. Review assigned ticket from Trello board

   
   
   
2. Navigate to local repo in terminal
3. Refresh local main branch

   First, ensure your main branch is checked out by simply running the following

   git checkout main

   Next, sync your local main branch to the remote main branch by running the following

   git pull

   Next, output the status of your repo by running the following

   git status

   Finally, observe the output and check that your branch is up to date by confirming the following text appears in your git status output
   
   
4. Create New Feature Branch

   Run the following with no square brackets where new_branch_name is a descriptive name that correlates to your assigned Trello ticket

   git branch [new_branch_name]

   Set your local working branch to your new feature branch by running the following

   git checkout [new_branch_name]

   List all your branches created for this repo by running the following

   git branch

   Confirm your new feature branch is selected by ensuring it appears in the output list and has an asterisk next to it
   
   Set your upstream branch by running the following

   git push -u origin <[new_branch_name]

   Push new branch to Github by running the following

   git push --set-upstream origin [new_branch_name]

   Check remote repository and assure new branch now appears in the list
   
   CONTACT GIT GUY IMMEDIATELY IF YOU RUN INTO ISSUES YOU DO NOT KNOW HOW TO RESOLVE
5. Develop Code in New Branch to Meet Trello Ticket Requirements

   Complete all development work in this branch (write functionality piece by piece and add, stage, commit between getting each piece working!)

   For reference, here are the comments to 1. stage, 2. commit, and 3. push
   • Stage changes by running

     git add -A

   • Commit changes by running

     git commit -m "commit message"

   • Push changes by running

     git push

   CONTACT GIT GUY IMMEDIATELY IF YOU RUN INTO ISSUES YOU DO NOT KNOW HOW TO RESOLVE
6. Submit Pull Request and Notify Reviewers

   Run the following

   git log

   Compare log output to remote branch commit history and ensure the most recent commit IDs match
   If remote repo not up to date, refer to step 5 to stage, commit, and push changes.
   Once local and remote branches are sync'd, submit pull request
   
   Notify reviewer(s) via Discord group chat that PR is ready for review
   CONTACT GIT GUY IMMEDIATELY IF YOU RUN INTO ISSUES YOU DO NOT KNOW HOW TO RESOLVE

NOTE: All discussion regarding PRs must be logged in PR comments. If voice call is necessary to resolve certain topics, one of the attendees of that conversation must include notes from the conversation as a comment in the PR. Merge conflicts should also be handled in the Github PR UI, and should always be handled by at least two people.

How we Seed(Installation Instructions)

Follow the following steps

• First make sure there isnt any changes that havent been migrated

  python3 manage.py makemigrations

• Migrate any changes that may be pending

  python3 manage.py migrate

• Drop your db through the terminal

  dropdb pitcru

• Create your db through the terminal

  createdb pitcru

• If you dont have requests folder download using the follow

  pip3 install requests

• Enter the python shell

  python3 manage.py shell

• Import the main app models folder

  from main_app.models import *

• Run the seeding function

  seed_db()

Next Steps

Actualize racing game car selection screen design for details page

Refactor backend to implement industry standard API such as KBB

Resolve issues with animation on pages with forms

Shorten form on homepage and expose button to toggle between simple and advanced search