This is the CodeSelfStudy.com website rebuilt in Flask/Python. More info will be posted here soon.
master-- don't use the master branch.dev-- you can edit the dev branch, but don't upload breaking changes.
- app -- contains all of the application code
- docs -- contains any documentation that we generate
- sandbox -- contains any code snippets and experiments that people want to share with the team, without adding that code to the actual application
- Flask Quickstart -- a quick overview to Flask.
- Flask example -- a quick example application in Flask.
- Restructured Text Cheatsheet -- This is a quick cheat sheet to help with formatting .rst documents.
To keep editor config sane, let's try to use the same coding style. Proposed formats are below. Discuss in chatroom or forum if you have other ideas about it.
Python:
- Code should conform to PEP8 (an easy standard to follow).
- Variable names and file names are snake_case.
JavaScript:
- Please use 4-space indentation (no tabs).
- Functions should have a space between closing parenthesis and opening curly brace:
function doSomething(n) { ... } - Anonymous functions get a space before the parentheses (the function has no name):
function (e) { ... } - Camel case for variable names.
- CSS IDs are camelCase:
$('#someId') - CSS classes are lowercase and have dashes:
$('.some-class') - Curly braces should be used, even when optional.
- Semicolons should be used.
- More info here: http://codeselfstudy.com/wiki/JavaScript_Coding_Style
The loader.gif is from loading.io. The terms of use when downloaded on July 1, 2015 are: "Term of Use All materials used in generating animated icons in this website, except the g0v icon, are created by loading.io. You can use them freely for any purpose."
DO NOT ADD COPYRIGHTED CODE TO THIS REPOSITORY. BY COMMITING CODE TO THIS REPOSITORY, YOU CERTIFY THAT THE CODE THAT YOU SUBMIT IS YOUR OWN AND THAT YOU RELEASE UNDER THE PROJECT'S MIT LICENSE.