on3iro / 4so-web-cookiecutter

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Note: This repo has been discontinued in favor of https://github.com/4so-fourseasons/web-cookiecutter

Web

ToC

4so-Web-Cookiecutter

This is our 4so web template to quickly scaffold web projects.

Installing / Getting started

To get started you first need to install Python and Cookiecutter, on your local maschine. Then you need to clone this repository.

Now just run the following command from the directory you ran the git clone command in and cookiecutter will guide you trough a minimal setup:

cookiecutter 4so-web-cookiecutter

This will create a new project in its own directory and update certain files according to the settings you made. This will also initialize a new git repository inside the new directory. You can then add some central repository (i.e. from our local GitLab) as a remote, make an initial commit and push the changes.

Developing

Built With

This project includes quite a few opinionated settings which where made according to our own guidelines. Therefore this template includes:

  • Webpack as module bundler, dev server and build tool
  • Babel for ES6 and Flow transpilation
  • Flow as type-checker
  • Standard as JS linter
  • StyleLint as scss/css linter
  • CSS-Autoprefixing via postcss
  • Jest as testing framework
  • SVG-Sprite for automatic sprite/scss generation
  • normalize.css as CSS-reset
  • Furhtermore the template is initialized with our README-template where basic setup/dev-server/build steps are already prefilled

Versioning

We can maybe use SemVer for versioning. For the versions available, see the link to tags on this repository.

About


Languages

Language:JavaScript 79.5%Language:CSS 10.5%Language:HTML 7.0%Language:Python 3.0%