LazyStarter

LazyStarter is a composable, component-based scaffolding framework.

• Extensible: Add your own components and templates.
• Language-Agnostic: Templates can be in your programming language of your choice
• Do It Once, Get It Twice: Write your components and we take care of creating the flags for you!
• Component-Based

Usage

Glossary

Bases: A Base is the minimum skeleton of buildable templates. Default bases include (landing-page, portfolio-page)

Components: components are children of Bases. A Component must be a child of at least one Base. Components are invoked via --flags. Default components include (navbar, navbar-searchbar, sidebar, footer, footer-big, --background-video)

Onboarding

To make sure everything runs smoothly and we don't have to get a super headache with git managment I would like every contributor to do a full (mock) pull request

Steps:

• fork this repository
• create a new branch. Prefereably just call it your username. (i.e. git checkout -b Zenahr)
• commit an empty commit like so: commit -m "my first pull request. Yay!" --allow-empty
• create a pull request via github
• wait for the merge

Congrats! You're ready to work on this repo now.

Contribution Guide

Version: 1.0

This document describes the way we will be handling our development cycles going forward

Issues

• Issues will be made by all of us.
• Issues will be assigned to us. This generally helps coordinate us as a team and prevent us from working on the same issue at the same time when it doesn't make sense to do so.

Pull Requests

• Main branch for development is dev
• General Pull Requests shall be directed towards the dev branch
• PRs will be reviewed by at least one fellow developer
• MR will be issued

Tracking

We will use our Kanban board for tracking our current points of interest (relevant issues). https://github.com/Zenahr/lazystarter/projects/1

Help

Help can be asked from anyone on the team via the Discord server. Git-specific problems should be discussed on the git-some-help channel.

Contributors:

• Zenahr (https://github.com/Zenahr)
• Martini (https://github.com/martinisiu)
• Luke (https://github.com/jls47)