Skip to content

Commit

Permalink
feat: enhance brand and config folders
Browse files Browse the repository at this point in the history
  • Loading branch information
jimbrig committed Aug 5, 2024
1 parent f20ed35 commit 3ee1e9e
Show file tree
Hide file tree
Showing 8 changed files with 53 additions and 1 deletion.
14 changes: 14 additions & 0 deletions brand/styles/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Client Branded Stylesheets

> [!NOTE]
> This directory is meant to store all client-branded stylesheets and assets.
> This includes all `CSS`, `SCSS`, `LESS`, `SASS`, and other stylesheets that are used to style client projects.
> These styles are typically not provided and instead must be inferred from the client's brand guidelines, website, or other assets.
## Contents

- [css](css/): A directory containing all client-branded `CSS` stylesheets. These styles may be compiled from
`SCSS`, `LESS`, `SASS`, or other preprocessor languages.

- [scss](scss/): A directory containing all client-branded `SCSS` stylesheets. Typically, `SCSS` is used as the primary
preprocessor language for stylesheets.
Empty file added brand/styles/scss/_mixins.scss
Empty file.
Empty file.
Empty file.
Empty file added brand/styles/scss/index.scss
Empty file.
11 changes: 11 additions & 0 deletions config/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
*
!.gitignore

!*.md
!*.encrypted.yml
!*.example
!*.template.yml

.env
config.yml
credentials.json
29 changes: 28 additions & 1 deletion config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,33 @@
> Typical configuration files include a primary `config.yml`, cloud `credentials.json`, tool-specific configuration files (i.e. `slack.yml`),
> and other configuration files specific to the client or client project(s).
## Contents
## Configuration Files

- [config.template.yml](config.template.yml): A template configuration file that can be used to create a `config.yml` file.
- [config.encrypted.yml](config.encrypted.yml): An encrypted configuration file that can be used to store sensitive information.
- [config.yml](config.yml): The primary (unencrypted) configuration file for the project. This file should be created from the `config.template.yml` file and should be git-ignored.

## Environment

- [.env.example](.env.example): An example environment file that can be used to create a `.env` file.
- [.env](.env): The primary environment file for the project. This file should be created from the `.env.example` file and should be git-ignored.

## Credentials

- [credentials.json](credentials.json): Cloud credentials file for the project. This file should be git-ignored.

## Tools

> [!NOTE]
> *Depends on the tools used in the project.*
Examples of common tool configurations include:

- Slack: (i.e. `slack.yml`) for Slack API Access, Slack Application Manifests, Webhook URLs, etc.
- Google Drive: (i.e. `gdrive.yml`) for Google Drive API Access, Folder Paths and IDs, etc.
- Google Sheets: (i.e. `gsheets.yml`) for Google Sheets API Access, Spreadsheet IDs, etc.
- Database Connections: (i.e. `db.yml` or `connections.dcf`) for Database Connection Strings, Hosts, Ports, Usernames, Passwords, etc.
- Email: (i.e. `email.yml`) for Email API Access, SMTP Server Information, etc.
- AWS: (i.e. `aws.yml`) for AWS API Access, S3 Bucket Names, IAM Roles, etc.
- Azure: (i.e. `azure.yml`) for Azure API Access, Blob Storage, etc.
- GCP: (i.e. `gcp.yml`) for GCP API Access, GCS Bucket Names, etc.
Empty file added config/config.template.yml
Empty file.

0 comments on commit 3ee1e9e

Please sign in to comment.