Project Boilerplate

A set of files and instructions to help setting up new projects. The goal is to stop repeating the same stuff and have the necessary boilerplate files ready when you start a project.

Contents

• Getting Started
• Prerequisites
• Installing
• Contributing
• Roadmap
• Authors

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

You will need to install git before using this.

sudo apt install git

Installing

Clone this repository

git clone https://github.com/MaxValue/Project-Boilerplate.git

Rename the created folder to your intended project name

mv Project-Boilerplate MyProject

Fill in the REAL_README.md file.

subl -n REAL_README.md

Fill in the REAL_README.md file.

subl -n REAL_README.md

Find fitting .gitignore instructions here and put them in your .gitignore file.

Run the init_project.sh script.

cd MyProject && sudo ./init_project.sh

Start programming!

For Python, you will find useful common structures in util.py.

Contributing

If you wanna help, please make an issue.

Roadmap

Things I already plan to implement, but didn't have yet:

• improve README. See here and here for good examples.

• template for bash

• template for processing

• git init code

   git config --global user.email "publicbetamax@example.com"
   git config --global user.name "Max Fuxjäger"
  
   echo "# Project-Boilerplate" >> README.md
   git init
   git add README.md
   git commit -m "first commit"
   git remote add origin https://github.com/MaxValue/Project-Boilerplate.git
   git push -u origin master
  

  • actually init the repo
  • "create" repo for all platforms
    • LIST HERE
  • multiple origin setup for git commits automate this in a script, see also https://gist.github.com/rvl/c3f156e117e22a25f242 and https://stackoverflow.com/questions/5785549/able-to-push-to-all-git-remotes-with-the-one-command git config --global alias.pushall '!git remote | xargs -L1 git push --all'

• gitignores

  • python
  • html
  • ruby
  • processing
  • lua

• LICENSE (See here for a list of them)

  • free for all
  • copyrighted
  • some others

• CONTRIBUTING.md [compare to other big projects and write it]

• ISSUETEMPLATE.md [compare to other big projects and write it]

• GitHub Webpage Template [test it out and find the necessary files. see if other platforms have pages support.]

• Wiki structure find wiki systems maybe i need to start another project only for that

• instructions on how to ...

• generate pypi packages

• boilerplate code

  • GUI
  • webservers
  • databases
  • argparse
  • configuration files

Authors

• Max Fuxjäger - Initial work - MaxValue

Inspiring Sources

• README template by PurpleBooth taken from here