BookAnEntertainer App - DJANGO App that works with PayPal

Overview

What this app is for?

This app allows you to search for and book entertainment for your event (App contains sample entertainers)

What does it do?

This app will allow users:

• Search for entertainers by type and location
• Read their profile
• View their gallery
• Listen to their recordings
• View their videos
• Book the entertainer

How does it work

There are 2 types of users: General and Entertainer Entertainers must register in order to create a profile. General Users can search the site but must be registered and logged in in order to make bookings or leave Reviews Reviews are made via Disqus plugin, so a user must also log in on Disqus to leave reviews. This app talks to an API to filter out entertainers by type and location. Users can then click into individual profiles

Features

Existing Features

• Home Page
• Search Page
• Profile Page
• Login Page
• User Registration Page
• Entertainer Registration Page
• Paypal payments
• API Docs page

Features Left to Implement

• Contact form on Entertainer Profile

Tech Used

• DJango I used Django for the Backend. It facilitated modelling of the entertainers and users. I also created an API that the search page could communicate
• Python Django uses Python
• AWS
  • The app stores it's STATIC and user uploadable MEDIA files in an S3 bucket
• Heroku
  • Hosts the application
• Paypal
  • Paypal Sandbox is used in order to facilitate test payments
• Disqus
  • Disqus is used to facilitate User Reviews of entertainers
• JQuery
  • JQuery is used to allow a responsive front end and to talk to the API
• Bootstrap
  • Bootstrap is used more menus and to give the app a simple responsive layout. I used version 4
• GITHUB
  • Facilitates code sharing and version control

Getting the code up and running locally

1. Log in to https://developer.paypal.com/
2. For testing, ensure you have a PAYPAL Personal and Business accounts set up as they will be needed to make purchases
3. For running on localhost, you will need to download ngrok.exe to suit your platform from ngrok website. Save it to your app's route folder
4. Open cmd prompt and navigate to app's route folder 1.If running locally, open cmd or Pycharm terminal, tell manage.py that you want to run in developer environment each time you do a command involving manage.py 1. E.G. Type 'python manage.py runserver --settings=settings.dev' 2.RUN NGROK by typing 'ngrok http 8000' 1. Can view requests in browser @ http://127.0.0.1:4040 3. In settings.py copy the https forwarding address setting from the running ngrok console.
   1. We need to add the address to the ALLOW_HOSTS list
   2. Also set PAYPAL_NOTIFY_URL with the same address
      1. E.G. PAYPAL_NOTIFY_URL = 'https://9f37a350.ngrok.io/to-ngrok-or-not-to-ngrok/
      2. The '/to-ngrok-or-not-to-ngrok/' corresponds to the PAYPAL route defined in /urls.py as
      3. url(r'^to-ngrok-or-not-to-ngrok/', include(paypal_urls)),
5. Run the program with command 'python manage.py runserver'

Connecting to the database on heroku

1. Download and install MYSQL Workbench
2. To retrieve connection settings, open command line and type:
   1. heroku login
   2. heroku config --app bookanentertainer
      1. Retrieve the CLEARDB_DATABASE_URL setting

API Documentation

1. Browse to https://bookanentertainer.herokuapp.com/docs/

Points to note

1. Since static files are hosted on AWS, any change made to JS or CSS files locally must be followed by the command
2. python manage.py collectstatic
3. This will then auto update the files in your S3 bucket
4. Then you should also push the new code to the master branch on GITHUB