Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexSkrypnyk authored Nov 9, 2023
1 parent 0b2a78e commit 750829c
Showing 1 changed file with 24 additions and 11 deletions.
35 changes: 24 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,41 @@
# CivicTheme - Development source site
Mono-repo used to maintain CivicTheme and accompanying modules that are automatically published to another repositories on release.
<p align="center">
<a href="" rel="noopener">
<img height=100px src="web/themes/contrib/civictheme/assets/logos/logo_secondary_light_mobile.png" alt="CivicTheme logo"></a>
</p>

<h1 align="center">CivicTheme - Development source site</h1>

<p>Mono-repo used to maintain CivicTheme and accompanying modules that are automatically published to another repositories on release.</p>

<div align="center">

[![GitHub Issues](https://img.shields.io/github/issues/salsadigitalauorg/civictheme_source.svg)](https://github.com/salsadigitalauorg/civictheme_source/issues)
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/salsadigitalauorg/civictheme_source.svg)](https://github.com/salsadigitalauorg/civictheme_source/pulls)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/salsadigitalauorg/civictheme_source)
[![CircleCI](https://circleci.com/gh/salsadigitalauorg/civictheme_source.svg?style=shield)](https://circleci.com/gh/salsadigitalauorg/civictheme_source)
![Drupal 10](https://img.shields.io/badge/Drupal-10-blue.svg)

![LICENSE](https://img.shields.io/github/license/salsadigitalauorg/civictheme_source)
[![RenovateBot](https://img.shields.io/badge/RenovateBot-enabled-brightgreen.svg?logo=renovatebot)](https://renovatebot.com)


[//]: # (DO NOT REMOVE THE BADGE BELOW. IT IS USED BY DREVOPS TO TRACK INTEGRATION)

[![DrevOps](https://img.shields.io/badge/DrevOps-develop-blue.svg)](https://github.com/drevops/drevops/tree/develop)
[![DrevOps](https://img.shields.io/badge/DrevOps-1.17.2-blue.svg)](https://github.com/drevops/drevops/tree/1.17.2)

</div>

---

> [!IMPORTANT]
> For Drupal theme installation instructions into your site, see https://docs.civictheme.io/development/drupal-theme
## Local environment setup

- Make sure that you have latest versions of all required software installed:
- [Docker](https://www.docker.com/)
- [Pygmy](https://github.com/pygmystack/pygmy)
- [Ahoy](https://github.com/ahoy-cli/ahoy)
- Make sure that all local web development services are shut down (Apache/Nginx, Mysql, MAMP etc).
- Checkout project repository (in one of the [supported Docker directories](https://docs.docker.com/docker-for-mac/osxfs/#access-control)).
- Authenticate with Lagoon
1. Create an SSH key and add it to your account in the [Lagoon Dashboard](https://ui-lagoon-master.ch.amazee.io/).
2. Copy `.env.local.default` to `.env.local`.
- `pygmy up`
- `ahoy build`

Expand Down Expand Up @@ -50,12 +65,10 @@ Copy `docker-compose.override.default.yml` to `docker-compose.override.yml`.

## More about CivicTheme

- [Documentation](https://docs.civictheme.io/)
- [CivicTheme UI kit](https://github.com/salsadigitalauorg/civictheme_library)
- [CivicTheme Drupal theme](https://www.drupal.org/project/civictheme)
- [Default content for CivicTheme Drupal theme](https://github.com/salsadigitalauorg/civictheme_content)
- [Admin adjustments for CivicTheme Drupal theme](https://github.com/salsadigitalauorg/civictheme_admin)
- [GovCMS adjustments for CivicTheme Drupal theme](https://github.com/salsadigitalauorg/civictheme_govcms)

---

For additional information, please refer to the [Documentation site](https://docs.civictheme.io/)

0 comments on commit 750829c

Please sign in to comment.