Starting new projects

When starting a new project you should use our project template from GitHub, so that you don’t have to set up basic things like linting and common scripts.

Our project template includes:

  • checking if source code has been formatted with prettier
  • linting JS files with our config
  • linting CSS files with our config
  • common scripts, e.g. for starting development or deploying to production
  • minimal continuous integration
  • basic folder structure
  • GitHub pull request template

How to use our project template as a starting point

1. Clone the project template repository to a new folder

Note: Replace new-project-name with the name of the folder where the project will be stored on your machine.

git clone git@github.com:diesdasdigital/project-template.git new-project-name

2. Reset the git history

⚠️ Go into the project folder before running these commands.

rm -rf .git &&
git init &&
git add . &&
git commit -am "add diesdas project template"

3. Create a new empty project on GitHub

If you have admin access go to the diesdas organization page and click on New. Make sure to not check the boxes to add a README or LICENSE so that it’s empty.

If you don’t have admin access ask Max or Harry. 🙂

4. Set the new repository as the origin

git remote add origin git@github.com:diesdasdigital/INSERT_REPO_NAME_HERE.git
git push -u origin master

5. Update README and package.json

Next step is updating the README and package.json to have the correct name and description of the project.

Note: You can hide unused parts of the README without deleting it. Add <!-- and everything below won’t be visible.

6. Enabling Travis CI

Last step is settung up continous integration. To have your code checked on pull requests and to enable deployments go to travis-ci.com/profile/diesdasdigital and enable your project via the toggle button.

Then click on the settings icon and enable:

✅ Build only if .travis.yml is present

✅ Build pushed branches

✅ Build pushed pull requests

✅ Auto cancel branch builds

✅ Auto cancel pull request builds