This is a template, which lays out a structure for a sub-project to the main LiveProjectsTemplateProject.
It can be used by any team working on an MMU LiveProject.
You can use this project to define a large project component, such as a RESTful service, or a cross-platform app.
NOTE: Your live projects are PUBLIC, on both GitHub and Trello, meaning anyone can see them.
To keep you and your client safe, here are some ground rules:
- NO authentication data:
- usernames, passwords
- shared secrets
- tokens
- NO real names
- no personally attributable data of any sort
Your repo will turn up on public searches. Likely initiated by people just like yourself; desperate for information. Please help them!
- Keep your code clear and consise
- Constructive comments only
- Give a helpful overview or how-to in a readme.md
Use a gitignore file: You'll find there is a need only to store a tiny fraction of your source files in a repo. These files depend on the sort of product you are building, and the frameworks you are using. More information (and a selection of gitignore files for common frameworks!) can be found here.
This file is your front page: Replace the above with text which will help the people who use your project, or may build on it next. Link to your brief, your design, how to build and how to use your product.