/oss-template

Template for OSS repos with a standard boilerplate

Primary LanguageHCLMIT LicenseMIT

PRs Welcome Contributors Forks Stargazers Issues MIT License


delineate.io

delineate.io

portray or describe (something) precisely.

[PROJECT_TITLE]

[PROJECT_DESCRIPTION]
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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 can be inserted to highlight the specific technologies used to create the solution from here.

Syntax Description
pre-commit Pre-commit git hooks that perform checks before pushes
GitHub Source control management platform
Docker Containerise applications and provide local environment
Terraform Cloud infrastructure provisioning configuration
Cloudflare Security and DNS services for internet services
Google Cloud Hosting of services on Google Cloud

Getting Started

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

Local Setup

This repo follows the principle of minimal manual setup of the local development environment, and utilises devcontainer.

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.

Infrastructure

Local Services

A boilerplate docker-compose file is provided that can be used to manage local environment services. The stack can be found at ops/local/stack.yaml.

# stands up the local services
task local:up

# tears down the local services
task local:down

Cloud Infrastructure

A boilerplate configuration is provided for using terraform configuration to provision cloud infrastructure. tfenv is used to select the version of terraform to use. The repo template provides a single component in ops/cloud/component.

# plans the network terraform config
task cloud:plan LAYER=component

# auto approves applying the network terraform config
task cloud:apply LAYER=component

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 delineate.io OSS projects please read:

License

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

Acknowledgements