📓 My workflow context and own code conventions
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
files Update Files Jul 9, 2016
guides Update AngularJS Guides Jul 14, 2016
README.md Fix typo Jan 22, 2018
logo-wg.jpg Update Logo Mar 28, 2014

README.md

Workflow Guide Logo

This is a work in progress and I will likely add (or replace) more functionality in the future.

Introduction

Hello there! I'm Vitor Britto, a Full Stack Developer extremely passionate about my work. I discovered the world of code almost two decades ago and kept the same passion from the first day of this discovery. I have worked full time as a freelancer for nearly 4 years developing projects for the web, and I direct part of my time to researchs, collaborative projects, development of personal projects and writing some articles for my blog.

But enough about me! I would like to present this project and why it was created.

First reason:

Apply rules and be based on a principle and methodology of process which could maintain the structure of my standards.

Second reason:

Not only have a code style guide, but relevant informations about my Workflow. Thus I always keep the same logic process and can initiate the development of my projects without any questions when making a scaffolding, building process, automation rotines, unit testing and others tasks.

This guide consists in four parts: 👻

  1. My workflow context with approaches and methods that I use.
  2. Tools that makes my Workflow easy.
  3. My own code conventions, which is inspired by what is popular within the community and flavored with some personal opinions.
  4. Major dependencies that I use.

In the last projects, Grunt shows some unstable performance in my Wofklow. I'm not saying that grunt is worse than Gulp. No! Unfortunately, it doesn't fits on my workflow anymore. I've been working a lot with Isomorphic Applications using JavaScript both on client and server-side Universal JavaScript Applications. Gulp, is programmatically closer to NodeJS. I love the pipe flow at Gulp. It reminds me the UNIX System ❤️.

Table of Contents


Candidate Tools

Zapier

The first tool in the list and a strong candidate to get into my workflow. So far, I'm comfortable with the free plan. I really like the way to trigger actions between apps.

Buddy

Buddy is a powerful Git Hosting with Continuous Delivery tools. I create an account on the platform, but I have not tested yet.

Stamplay

With Stamplay I can chain together APIs as if they are Lego blocks arranging them into service based apps. If can automate tasks, connection some tools and triggering actions to build a data flow on Back-End. So, you can "create web applications without writing tons os backend codes".

⬆ back to top


Workflow

You can find a complete list of applications, utilities, DevOps and Business Tools here: Stack Share

This is a simple table with approaches and methods that I use at my Workflow.

Strategy Blueprint Visual Develop Build Deploy
Research Sitemap Concepting Scaffolding Lint Test
Observe Wireframe Presentation Libraries Concatenate Optimize
Understand Prototype Refine Templates Minify LAUNCH
Analyze Style Guide Approval Frameworks Compile
Timeline Usability Database

⬆ back to top

Strategy and Management

⬆ back to top

Blueprint and Visual

⬆ back to top

Development

Scaffolding

The Boilerplates repository is my personal Yeoman. I organize and setup my stacks for every kind of project. It's a kick start structure and configuration. With this guy, I can start coding in a few minutes.

Coding

Front-End:

  • HTML5
  • CSS3
  • JavaScript

Back-End:

  • NodeJS
  • PHP

Database

  • MySQL
  • SQLite
  • PostgreSQL
  • Redis
  • MongoDB
  • GraphQL

Editors

  • Visual Studio Code
  • MacVim

Building

Transpilers Frameworks Libraries Template Engine CSS Supersets Others
Babel Angular jQuery Pug Sass WordPress
TypeScript Express ReactJS EJS Stylus WooCommerce
        | Slim       |           |                 | PostCSS       | React Native
        | Laravel    |           |                 |               | 
        |            |           |                 |               |
        |            |           |                 |               |

... and much more!

⬆ back to top


Guides

⬆ back to top

General Notes

  • [STRATEGY]: a mix of GTD and Scrum methods.
  • [DEVELOPMENT]: use the SOLID principles.
  • [BUILD]: all files must have two spaces (soft tab) for indentation.

Be Consistent

The point of having style guidelines is to have a common vocabulary of coding so people can concentrate on what you're saying rather than on how you're saying it. We present global style rules here so people know the vocabulary, but local style is also important. If code you add to a file looks drastically different from the existing code around it, it throws readers out of their rhythm when they go to read it. Avoid this.

Google C++ Style Guide

⬆ back to top

References

⬆ back to top

License

MIT License © Vitor Britto