Skip to content

Commit

Permalink
init project
Browse files Browse the repository at this point in the history
  • Loading branch information
pascalandy committed Feb 7, 2020
1 parent a1e7995 commit 155a8fa
Show file tree
Hide file tree
Showing 65 changed files with 2,158 additions and 2 deletions.
106 changes: 104 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,104 @@
# ghost-local-dev-in-docker
A local workflow to easily develop your Ghost themes by running Ghost within a Docker container.
## What problem does this project solves?

**First**, as I [maintain many Ghost Themes](https://github.com/firepress-org), my pain was growing exponentially. I needed to develop & maintain those themes quickly, test them, using real content that makes sense. All of this without putting unnecessary stuff in the git repo of each theme.

I was always running after my tail as soon as I was switching between different themes or duplicating hundred of MB to duplicate my Ghost setup.

**Second**, there are many Ghost themes on Github without a proper live demo. I just wanted to download a few of them to see the result locally. Oh, and did I saw the pain to work between different machines?

This project solves all of that and makes the whole process efficient.

## What is this?

It’s a workflow to run Ghost locally within a Docker container. Once your local paths are define it’s really fun and easy to work between many themes.

**Two-goal here**:

1. It’s for **developers** who needs to quickly re-start ghost on the fly (about 3 sec) while they develop a their Ghost themes.
2. It’s for **everyone** who wants to see & try Ghost theme locally.

I have worked and re-work this workflow and with my experience, I can confirm it covers many **use cases** I have.

- Run Ghost images with tag `edge` or `stable` (you can choose them from: https://hub.docker.com/r/devmtl/ghostfire/tags/)
- Run Ghost Themes I develop actively which are in my Github local setup.
- Run Ghost Themes I want to try on the fly. Just unzip any themes in the directory `theme_tryout` and your Ghost container will see it.
- It shut down the containers automatically after 1 hours.
- When starting, the workflow tests many elements like:
- What is the Ghost version
- What is the Node version
- Ensure Ghost does response is up


## Video & tutorial about using this

- ToDo, 2018-08-23


## Docker image source

The [docker images I use](https://github.com/firepress-org/ghostfire) are continuously integrated (built every day) thanks to Travis. See the latest images at: https://hub.docker.com/r/devmtl/ghostfire/tags/


## Basic Setup

Because this workflow syncs themes locally, you need to tweak some variables before anything.

1. Duplicate `var-config-example.sh` and rename it as `var-config.sh`
2. Configure your local environment within `var-config.sh`
3. `./run.sh`
4. In your browser, go to `http://localhost:2368/` & `http://localhost:2368/ghost`

That’s it!


## Details

- Executing `./run.sh` runs the `stable` image
- Executing `./runedge.sh` runs the `edge` image
- Executing `./rundown.sh` shutdown the container
- Directory `theme_stable` is where your Ghost Themes are considered stable. You should never copy anything manually in there.
- Directory `theme_tryout` is where you can manually copy theme within. Copy and unzip Ghost theme you want to try here
- Directory `content` is where the Ghost container mount its volume. You should never copy anything manually in there.


## Contributing

Thanks to the power of communities, this is where `1 + 1 = 3`.

1. Fork it
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request


## Sources & Fork

- This Git repo is available at:<br> https://github.com/firepress-org/ghost-local-dev-in-docker


## License

- This git repo is under the **GNU** license information. [Find it here](https://github.com/pascalandy/GNU-GENERAL-PUBLIC-LICENSE).
- The Ghost’s software, is under the **MIT** license. [Find it here](https://ghost.org/license/).


## FirePress Hosting

**At FirePress we do one thing and we do it with our whole heart: we host fully managed Ghost’s websites**. The idea behind FirePress is to empower freelancers and small organizations to be able to build an outstanding mobile-first website.

We also offer a **workshop** where participants ends up with a website/blog they can easily operate themselves. Details are coming soon. It is available in those cities:

- Montréal - Canada
- Toronto - Canada
- New-York - USA
- Québec City - Canada

Because we believe your website should speak up in your name, we consider our mission completed once your site has become [your impresario](https://play-with-ghost.com/ghost-themes/why-launching-your-next-website-with-firepress/). Start your [free trial here](https://play-with-ghost.com/ghost-themes/free-10-day-trial/).


## Keep in touch

- [Pascal Andy’s « now page »](https://pascalandy.com/blog/now/)
- Follow me on [Twitter](https://twitter.com/askpascalandy)
- Find more Ghost Themes on [play-with-ghost.com](https://play-with-ghost.com/)
22 changes: 22 additions & 0 deletions _my_themes/liebling/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Copyright (c) 2018-2019 Eduardo Gómez

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
109 changes: 109 additions & 0 deletions _my_themes/liebling/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
# Liebling

Liebling is a beautiful and clean Ghost theme that is easy and comfortable to use. **It's free** and you can use it for any kind of content you might have. Now with dark mode 🌓!

If you use it and you like it, please consider to make a donation to support its development! 🙏🏼

<a href="https://www.buymeacoffee.com/eddiesigner" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/black_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>

## Preview

You can see a live demo here: [https://liebling.eduardogomez.io](https://liebling.eduardogomez.io)

![](https://res.cloudinary.com/edev/image/upload/v1570370297/liebling/liebling-promo-ipad.jpg)
<br><br>
![](https://res.cloudinary.com/edev/image/upload/v1570370297/liebling/liebling-promo-mobile.jpg)

## Download

To get the latest version please head over the [releases page](https://github.com/eddiesigner/liebling/releases) and download the file `liebling.zip` of the latest release.

## Features

### General features

* Clean and beautiful design 💅🏼
* Lightning fast ⚡️
* Fully responsive, looks great on any device 📱
* Compatible with modern browsers 💻
* Fast support 📞

### Ghost features

* Subscription form
* Multiple authors
* Logo support
* Featured posts and pages
* Post, Page, Tag, Authors, pages
* Koenig editor
* Bookmark card
* Gallery card
* Blog title and description
* Cover image for Home, Post, Page, Tag, Author pages
* Author avatar, bio, location, website and social links
* Facebook and Twitter social links
* Reading time
* Next and Previous post navigation
* Primary tag in posts

### Liebling unique features

* Dark mode
* Search
* Custom Subscribe page
* Custom authors page
* Custom error page
* Medium style image zoom
* Comments with Disqus
* Share post on Facebook and Twitter
* Slider for featured posts
* Support for normal, wide and full images in posts
* Reading progress indicator
* RTL language support

## Localization

* English
* Spanish
* German by [D3473R](https://github.com/D3473R)
* Informal german by [D3473R](https://github.com/D3473R)
* Bulgarian by [clappingmonkey](https://github.com/clappingmonkey)
* Vietnamese by [hiensarahly](https://github.com/hiensarahly)
* Italian by [vignini](https://github.com/vignini)
* French by [v1nc3nt-fr](https://github.com/v1nc3nt-fr)
* Informal french by [v1nc3nt-fr](https://github.com/v1nc3nt-fr)
* Portuguese by [ivomota](https://github.com/ivomota)
* Arabic by [allamiro](https://github.com/allamiro)
* Polish by [otlet](https://github.com/otlet)
* Brazilian portuguese by [pedrinholula](https://github.com/pedrinholula)
* Russian by [stereohorse](https://github.com/stereohorse)
* Kyrgyz by [januchaos](https://github.com/januchaos)
* Hebrew by [cohen604](https://github.com/cohen604)

## Theme tested

* W3C Markup Validation: [Correct validation](https://validator.w3.org/nu/?doc=https%3A%2F%2Fliebling.eduardogomez.io%2F)
* Ghost GScan: [100/100 points](https://gscan.ghost.org/)
* GTmetrix PageSpeed Score: **A (97%)**
* PageSpeed Insights: **94/100** (mobile) **99/100** (desktop)
* Pingdom Performance Grade: **A 91**

## Theme development

Thanks to [D3473R](https://github.com/D3473R) 💪🏼 for create a development environment with Docker. From now on you can work on this theme without installing a Ghost instance on your local machine. With two commands you have an instant development setup and you can build the theme for production.

Please take a look to this page to see how it works: https://github.com/eddiesigner/liebling/wiki/Theme-development-with-Docker

## Help and Support

To enable the search, comments, subscribers and so on, you must follow the steps found in the [Wiki](https://github.com/eddiesigner/liebling/wiki).

If you have any questions or troubles with this product, please feel free to open an issue [here](https://github.com/eddiesigner/liebling/issues).

## License

Copyright (c) 2018-2019 Eduardo Gómez. Released under the [MIT license](https://github.com/eddiesigner/liebling/blob/master/LICENSE).

## Credits

All photos I used on this theme are from [Unsplash](https://unsplash.com)
1 change: 1 addition & 0 deletions _my_themes/liebling/assets/css/app.css

Large diffs are not rendered by default.

Binary file added _my_themes/liebling/assets/fonts/icomoon.eot
Binary file not shown.
Loading

0 comments on commit 155a8fa

Please sign in to comment.