Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/peteoshea/base-template

Generic template for any type of project
https://github.com/peteoshea/base-template

Last synced: 9 days ago
JSON representation

Generic template for any type of project

Awesome Lists containing this project

README 

        
# Base Template



[![CI](https://github.com/peteoshea/base-template/workflows/CI/badge.svg)](https://github.com/peteoshea/base-template/actions)



A generic template repository for any type of project.

This includes both PowerShell and bash scripts to manage your development environment.

For more details of these scripts check out the following projects:

- [powershell-scripts-to-rule-them-all](https://github.com/peteoshea/powershell-scripts-to-rule-them-all)

- [scripts-to-rule-them-all](https://github.com/peteoshea/scripts-to-rule-them-all)



## The Scripts



The following is a list of scripts and their primary responsibilities.

There are bash and PowerShell versions of these scripts and you can call the PowerShell versions with or with the `.ps1` suffix.



### [script/setup][setup] / [script/setup.ps1][setup.ps1]



Used to set up a project in an initial state.

This is typically run after an initial clone, or, to reset the project back to its initial state.



### [script/update][update] / [script/update.ps1][update.ps1]



Used to update the project after a fresh pull.

This should include any database migrations or any other things required to get the state of the app into shape for the current version that is checked out.



### [script/test][test] / [script/test.ps1][test.ps1]



Used to run the test suite of the project.

To allow this script to be run from CI setup should be done outside of this script.

A manual call to [update][update]/[update.ps1][update.ps1] before running the tests is usually a good idea.



A good pattern to support is having optional arguments that allow you to run specific tests.



Linting is also be considered a form of testing.

These tend to run faster than tests, so put them towards the beginning so it fails faster if there's a linting problem.



### [script/server][server] / [script/server.ps1][server.ps1]



Used to start the application.



For a web application, this might start up any extra processes that the application requires to run in addition to itself.



The [update][update]/[update.ps1][update.ps1] script is called ahead of any application booting to ensure that the application is up to date and can run appropriately.



## Installing Dependencies



The [bootstrap][bootstrap]/[bootstrap.ps1][bootstrap.ps1] script, called from both [setup][setup]/[setup.ps1][setup.ps1] and [update][update]/[update.ps1][update.ps1] scripts,

is used solely for fulfilling dependencies of the project.

This can mean installing packages, updating git submodules, etc.

The goal is to make sure all required dependencies are installed.



### PowerShell Package Managers



The PowerShell scripts currently allow for following package managers:



#### [Chocolatey](https://chocolatey.org/)



If you have some [Chocolatey](https://chocolatey.org/) packages required then you can simply add a

`chocolatey-packages` file at the top level of the project with a list of the packages and they

will be installed and updated as required.

Simply having the `chocolatey-packages` file means Chocolatey will be installed and updated.



#### [winget](https://github.com/microsoft/winget-cli)



Microsoft has recently released it's own package manager

[winget](https://github.com/microsoft/winget-cli).

This is currently only a preview so some functionality may not be available yet but it sounds

promising so if you want to use this to install some packages then you can simply add a

`winget-packages` file at the top level of the project with a list of the packages and they will be

installed and updated as required.



### Bash Package Managers



The bash scripts currently allow for following package managers:



#### [APT](https://en.wikipedia.org/wiki/APT_(software))



If you are on a Debian based Linux system, like Ubuntu, then you can create an `apt-packages` file with a list of the required packages.

You must ensure that this file has Linux line-endings (LF) otherwise it may not work as expected.



#### [yum](https://en.wikipedia.org/wiki/Yum_(software))



If you are on a RedHat based Linux system, like CentOS or Fedora, then you can create an `yum-packages` file with a list of the required packages.

You must ensure that this file has Linux line-endings (LF) otherwise it may not work as expected.



#### [Homebrew](https://brew.sh/)



You can use [Homebrew](https://brew.sh/) by creating a `Brewfile` at the top level of the project with a list of the packages to be installed.

Simply having the `Brewfile` means Homebrew will be installed and updated.



[bootstrap]: script/bin/bootstrap

[bootstrap.ps1]: script/bin/bootstrap.ps1

[server]: script/server

[server.ps1]: script/server.ps1

[setup]: script/setup

[setup.ps1]: script/setup.ps1

[test]: script/test

[test.ps1]: script/test.ps1

[update]: script/update

[update.ps1]: script/update.ps1