3. Developer Guide

• 3.1. Makahiki Development Environment
  • 3.1.1. Using the Makahiki VirtualBox Virtual Machine
  • 3.1.2. Using an IDE
  • 3.1.3. Fork the Makahiki source
  • 3.1.4. Workon makahiki
  • 3.1.5. Initialize or update the Makahiki instance
  • 3.1.6. Run Makahiki outsite of Eclipse
  • 3.1.7. Import the Makahiki Project into Eclipse
  • 3.1.8. Create a Run Confiugration in Eclipse
• 3.2. Coding Standards
  • 3.2.1. Automated quality assurance
  • 3.2.2. Coverage
  • 3.2.3. General documentation string standards
  • 3.2.4. Module documentation
  • 3.2.5. Function documentation
  • 3.2.6. Variable documentation
• 3.3. Theme Development
  • 3.3.1. Create a local installation
  • 3.3.2. Set environment variables for theme development
  • 3.3.3. Create your new theme file
  • 3.3.4. Add your theme to the installed themes
  • 3.3.5. Verify your theme installation
  • 3.3.6. Determine your color palette
  • 3.3.7. Specify your palette in your theme file
  • 3.3.8. Define the background theme
  • 3.3.9. Define the Navigation Bar theme
  • 3.3.10. Define the Info Bar theme
  • 3.3.11. Define the Quest Bar theme
  • 3.3.12. Define the widget theme
  • 3.3.13. Define the notifications theme
  • 3.3.14. Define the modal dialog box theme
  • 3.3.15. Define the Info Box theme
  • 3.3.16. Define the Smart Grid Game theme
  • 3.3.17. Define the Raffle Game Theme
  • 3.3.18. Define the Badge themes
  • 3.3.19. Define the default font and link colors
  • 3.3.20. Seeing everything at once: the theme-display page
  • 3.3.21. Cleanup: Delete the prior theme’s variable definitions
  • 3.3.22. Create a compiled (CSS) version of your theme
  • 3.3.23. Push your changes
• 3.4. Hello World Widget Development
  • 3.4.1. Create a local installation
  • 3.4.2. Set environment variables for theme development
  • 3.4.3. Create the hello world widget package
  • 3.4.4. The Widget’s User Interface index.html
  • 3.4.5. Providing data to the UI views.py
  • 3.4.6. Add your widget to the installed widget apps
  • 3.4.7. Add the widget to a page
  • 3.4.8. Verify your widget installation
  • 3.4.9. Enter the help text for the Hello World Widget
  • 3.4.10. Push your changes
• 3.5. Design periodic tasks
  • 3.5.1. About periodic tasks
  • 3.5.2. Getting to the periodic tasks page
  • 3.5.3. Configure a periodic task
• 3.6. Testing
  • 3.6.1. Install Firefox
  • 3.6.2. Run the test suite
  • 3.6.3. Creating Tests
  • 3.6.4. Creating Selenium Tests
  • 3.6.5. Editing exported Selenium tests to run within our test framework
• 3.7. Heroku command line in a nutshell
  • 3.7.1. Help
  • 3.7.2. Logging in
  • 3.7.3. Application configuration
  • 3.7.4. Running manage.py commands
  • 3.7.5. See the logs
  • 3.7.6. See process status
  • 3.7.7. To scale an app
  • 3.7.8. How a collaborator can push a new app
• 3.8. Logging and analysis
• 3.9. Enhancement Ideas
  • 3.9.1. Real-time player awareness
  • 3.9.2. Deep Facebook integration
  • 3.9.3. Action Library Management System