facform (Real name TBC)

Week 8 project for FAC5 to create a learning platform for Founders & Coders.

Production

For ease of use, this production section will be at the top of the README until end of the initial sprint on Friday. This production section contains a section on rules to help us work better, production standards, as well as production resources and a production log.

Repo Owner

Technically: everyone. However the person responsible for any issues with the Repo (merge conflicts, broken branches, bad dependencies, etc) is Jack M. In order to be able to help, Jack will be doing his best to keep up to date with all pull requests to the Master branch, so please let him know if/when your team has code to contribute.

Rules

• Anyone pushing to the master branch from their local computer has to buy a round of drinks for everyone on friday.
• Anyone merging their own pull request to the master branch has to buy a round of drinks for everyone on friday.

Resources

Pivotal Tracker: Project tracking located here

Project Wireframes: Located at Google Slides

More to come...

Production Standards

Branches, Commits and Pull Requests

• Please work on branches with relevant and specific names, for the sake of others.
• Please include specific file changes in your commit messages. Better "test/tests.html updated" than "Tests updated".
• Please include the URL link to your pivotal tracker story in the comments for any pull request to the master branch.
• Please take one minute to make your pull request comments as detailed as possible for people who are working on completely different sections of the site.

Code Coverage

• Master Branch minimum code coverage: 100%

Testing

• You are responsible for writing tests for your own code. If you want to contribute to the master branch, please ensure that you have relevant tests in place.

Code Style

• For the sake of consistency, please use double-space linting on code. You can also use JS Fiddle if you are feeling lazy.
• Check your code with JS Lint
• Please use JSDoc to comment your code.
• Please order CSS alphabetically.

Production Log

• Monday 29/6: Voted on project. Pivotal tracker set up. Wireframes created. Repo set up.
• Tuesday 30/6: Role days. Rethink linked to Heroku.
• Weds 1/7: Servers, routes, handlers all up. Detailed wireframes up.

Basic Idea

TBC.

Tech Used

TBC.

Codewars

We are using the Codewars API to allow a user to select a kata to work on. A user has a choice of kyu levels 1-8, or 'default' to level up on their account, or 'random'. The user can also access their own profile information. The endpoints are as follows:

• /kyu/{level}, where 'level' can be a number between 1 and 8, or 'default', or 'random'
• /user/{username}

Currently the API calls have to be authenticated with a user's own personal API key, which has to be taken from their own account settings. For the time being, the API key has been set to a specific value, though there will be an error as it seems to expire after a few hours.

We aim to be able to extract a kata description, as well as the kata setup and the url, in order to enable people to pair on code using a collaborative editor.