I will be accepting up to one pull request per day on this project.
Switch branches/tags
Nothing to show
Clone or download
Latest commit b7009e8 Aug 15, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ci
images
scripts
stylesheets
vendor
.csslintrc
.editorconfig
.gitignore
.htmlhintrc
.jshintignore
.jshintrc
.travis.yml
LICENSE.txt
README.md
admin.html
favicon.ico
game.html
index.html

README.md

1pr

I will be accepting up to one pull request per day on this project.

View the result at thepracticaldev.github.io/1pr.

Build Status Gitter

Project Journal

How to contribute

  • Fork the repository
  • Add something awesome
  • Create a pull request
  • Hope you get picked

Project structure

The project's structure is pretty simple.

  • HTML files go in the root directory
  • CSS goes in the stylesheets/ directory
  • Javascript goes in the scripts/ directory
  • Third-party libraries (CSS and JS) go in the vendor/ directory, which is ignored by the linters (see Testing below).

Coding standards

When contributing, please try to follow the coding standards so we have nice looking code that's easy to follow for everyone.

Editorconfig

Where possible, use an editor (or a plugin for your editor) that supports editorconfig.

The editorconfig file should set your editor to the following settings automatically:

  • UTF-8 charset
  • Unix-style line breaks
  • End file with a new line
  • No trailing whitespace before a line break
  • Use tabs for indentation, apart from in Markdown files where spaces are preferred

Tab width is not defined in the editorconfig, so each deveveloper can set their editor's tab width to what they're most comfortable with.

Furthermore

  • Add comments to your code where necessary. The project should be accessible for devs of all experience and skill levels. Better to have too many comments, than none at all.
  • Whitespace is not the enemy! A couple of empty lines between blocks of code can really improve readability.

For Javascript specifically

  • Use semicolons (even through they're not strictly necessary). It's good practice!
  • Use let and const where applicable, to keep the scope of your variables specific. Don't know what scope is or what let does? Check out this article.
  • Use lowerCamelCase for variable names (not snake_case)

Testing

The project contains the files .htmlhintrc, .csslintrc and .jshintrc with configuration for the respective testing utilities.

To install the testing utilities locally, simply install Node.js and then use npm (bundled with Node.js) to install the utilities:


npm install --global htmlhint csslint jshint

HTML validation

Run the HTML validator with:


htmlhint

  • All tags should be lowercase
  • Use double quotes for attributes
  • No duplicate attributes
  • HTML5 doctype on the first line
  • Must have a title tag
  • IDs must be unique
  • Src and alt attribute required on images
  • No scripts in the head (place them at the bottom of the body)
  • No inline style attributes or javascript event handlers (e.g. onclick="")

CSS validation

Run the CSS validator with:


csslint stylesheets

  • No empty rules
  • No duplicate properties with the same value
  • Limit the amount of floats used
  • Limit the amount of different font sizes used
  • Don't use !important
  • Don't use outline: none unless you have a :focus rule on the same element to replace the outline
  • Don't use elements in the css when only a class name will suffice
  • Don't use regex selectors
  • Encourage the use of shorthand notation

JS validation

Run the Javascript validator with:


jshint scripts

  • Always use strict mode
  • Avoid using bitwise operators
  • Always use curly brackets, even for a single line
  • Compare values with === and !== for type safety
  • Don't extend prototypes of native objects (e.g. Array or Date)
  • Don't use the comma operator
  • Avoid declaring variables that are already declared in a higher scope
  • Avoid declaring variables and not using them

Storing Data

1pr is backed by a Firebase database. This allows you to save and share data armed with just the knowledge of JSON rather than having to understand structuring a database or sql etc..

To set up a test database and add yourself as administrator:

  1. create a Firebase account and project

  2. replace the config details in scripts\database\config.js with the config details shown in the Firebase console

  3. copy the contents of scripts\database\firebase-rules.json into the database rules section of the console

    (Re-do this every time you pull new changes into your fork that change the rules file)

  4. under the authentication section of the console, enable GitHub authentication (follow the instructions there)

  5. (optionally add your github.io subdomain or other domains where you can access your site as an authorised OAuth redirect domain)

  6. serve your files

  7. navigate to your 1pr homepage

  8. click the sign in button in the sidebar to sign in with GitHub and generate a database account for yourself

  9. go to the users panel of the authentication section of the Firebase console and copy the uid for your newly-generated account

  10. go to the data panel of the database section and:

    1. add a node named admins as a child of the root node
    2. click the plus to add a sub-node
    3. copy your uid into the name of that sub-node and add a value of true
    4. click add to save the changes
  11. go back to your 1pr page and refresh.

  12. click the newly-visible Manage Web App link

  13. Click run migrations to apply all database changes to your Firebase database

    (Re-run this every time you pull new changes into your fork that change the database)

To develop with the database:

  • Use the documentation to find out how to save and load data

  • By default the rules only allow administrators to edit the database, so make sure you've given yourself that role

    This is important - Firebase allows connections from localhost so (given the connection details are public) anyone could serve their own script that reads and writes to the database maliciously

  • Make a new top-level node for each feature (unless it particularly makes sense not to)

  • Remember to update the rules to allow non-admins to use your feature, though be restrictive rather than permissive

  • Remember to test those rules using the simulator build into the rules interface

  • Record the steps you take modifying the structure and data within the database in a migration:

    1. Open up scripts\database\migrations.js

    2. Find the end of the migrations array

    3. Add a new object, following the pattern of the existing migrations, i.e.

      
      {
          //unique identifier for the migration
                 name: "doNothing",
      
          //talk about what your changes do
          description: "Does nothing of substance. Does add to the migration history.",
      
          //function that returns a promise
          // (or other thenable object) that
          // enacts the data manipulation to
          // achieve what you want to do
          doMigration: function(){return Promise.Resolve();}
      }
      
      
    4. Test your migration by using the button on the admin page

      There's no mechanism to roll back migrations yet, so testing multiple times requires deleting all but the admins node from the database and rerunning all migrations again

  • Add the class signed-out to any elements you want to be visible when the user isn't signed in

  • Add the classes signed-in and hidden to the elements you want to show when the user is signed in

  • Add the classes signed-in-admin and hidden on top of the regular signed-in hidden to the elements you want to show when the user is signed in as an admin