[PROJECT_TITLE]

[PROJECT_DESCRIPTION]
Explore the docs »

View Demo · Report Bug · Request Feature

Contents

• About The Project
• Built With
• Getting Started
  • Local Dependencies
  • Local Setup
• Usage
• Roadmap
• Contributing
• License

About The Project

The repo description should be added here and describe at least:

• Purpose of the repo e.g. problem/opportunity statement
• High level description of the overall approach/solution

Built With

Further logos should be inserted to highlight the specific technologies used to create the solution from here.

Getting Started

To get a local copy up and running follow these simple steps.

Local Dependencies

A number of local dependencies are required. To review the local dependencies:

• When using MacOS run make requirements
• otherwise run cat Brewfile to inspect the requirements

If additional dependencies are required they should be added to Brewfile, for more details please review the official brew bundle documentation here.

Local Setup

This repo follows the principle of minimal manual setup of the local development environment.

A make target has been provided for simplicity make init, the make file can be inspected for more details.

# use the folder name as the repo name
make init

# explicitly pass in the repo name (e.g. my-service)
make repo=my-service init

If at any point the repo name needs to be changed then the make rename target can be called.

make repo=my-service rename

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

If you would like to contribute to any Capco Digital OSS projects please read:

• Code of Conduct
• Contributing Guidelines

License

Distributed under the MIT License. See LICENSE for more information.

• Best README Template
• Markdown Badges
• DocToc