Skip to content
Joke Trainer: Full Stack NSS Capstone, built in Python/Django. Designed for people who love jokes but have a difficult time remembering them, Joke Trainer is entertaining and useful at the same time.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Welcome to Joke Trainer!

Things you can do in Joke Trainer-

  • Browse the built-in library of animated jokes by keyword search or category
  • Register an account
  • Add jokes to your collection of favorites
  • Use the Joke Trainer feature to commit your favorite jokes to memory with hints and flashcards
  • Add and integrate your own jokes with the existing library

Joke Trainer ERD: Joke Trainer ERD

To access Joke Trainer in your terminal:

SET UP A VIRTUAL ENVIRONMENT

  1. Create a folder for the project named JokeTrainer (or whatever you'd like) and navigate into the folder
  2. Initialize a virtual environment from within your new folder a. virtualenv env
    b. source env/bin/activate
    c. (To end your virtual environment: deactivate)

INSTALL DJANGO

  1. Within your new folder (but outside of the virtual environment folder) install Django by typing:
    a. pip install django

CLONE DOWN JOKE TRAINER

  1. Clone down the Joke Trainer project:
    a. git clone https://github.com/robbyhecht/joke-trainer.git
    b. pull down the branch designated for development using the commands:
    git fetch --all
    git pull origin DEVELOPMENT

  2. There should now be a folder called joke_trainer-- navigate into this folder

MAKE A DATABASE

  1. Create your database by typing-- python manage.py makemigrations

  2. Then to activate migrations, enter-- python manage.py migrate

  3. You can access the SQLite database now by opening the file inside your project called db.sqlite3 in DB Browser.

POPULATE THE DATABASE

  1. You can populate the database with the existing file db.json by typing-- pyman loaddata db.json

FIND JOKE TRAINER IN YOUR BROWSER

  1. Start up your local server by typing: python manage.py runserver

  2. In your browser, you should now see the Joke Trainer homepage at localhost:8000

Sections in Joke Trainer

Navigation Bar

  • Links to home page, favorites page, trainer page, registration and login/logout
  • Search bar

Home Page

  • Left column contains links to descriptions of the various site functionalities
  • Center column has a random "Joke of the Moment"
  • Right column contains links to the various joke categories. Once you are logged in, the top category contains your personal jokes

Joke Trainer ERD

Favorites

  • Once you're logged into an account, each joke will have a blue button that lets you add the joke to your list of favorites, which appear on the favorites page

Joke Trainer ERD

Trainer

  • The coolest part of the site. The Trainer page is where you can use Joke Trainer to help yourself memorize your favorite jokes. You'll find only a hint on the front of the card, with the entire joke on the back. Use these flashcards to build your repertoire as a master joke teller.

Joke Trainer ERD

Add Your Own Jokes

  • Once you're logged into an account, you can add as many jokes as you want to the database. Your jokes will integrate into the existing library, but will only be visible to you when you're logged in.
You can’t perform that action at this time.