Skip to content

Commit 155a8fa

Browse files
committed
init project
1 parent a1e7995 commit 155a8fa

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+2158
-2
lines changed

README.md

Lines changed: 104 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,104 @@
1-
# ghost-local-dev-in-docker
2-
A local workflow to easily develop your Ghost themes by running Ghost within a Docker container.
1+
## What problem does this project solves?
2+
3+
**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.
4+
5+
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.
6+
7+
**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?
8+
9+
This project solves all of that and makes the whole process efficient.
10+
11+
## What is this?
12+
13+
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.
14+
15+
**Two-goal here**:
16+
17+
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.
18+
2. It’s for **everyone** who wants to see & try Ghost theme locally.
19+
20+
I have worked and re-work this workflow and with my experience, I can confirm it covers many **use cases** I have.
21+
22+
- Run Ghost images with tag `edge` or `stable` (you can choose them from: https://hub.docker.com/r/devmtl/ghostfire/tags/)
23+
- Run Ghost Themes I develop actively which are in my Github local setup.
24+
- 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.
25+
- It shut down the containers automatically after 1 hours.
26+
- When starting, the workflow tests many elements like:
27+
- What is the Ghost version
28+
- What is the Node version
29+
- Ensure Ghost does response is up
30+
31+
32+
## Video & tutorial about using this
33+
34+
- ToDo, 2018-08-23
35+
36+
37+
## Docker image source
38+
39+
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/
40+
41+
42+
## Basic Setup
43+
44+
Because this workflow syncs themes locally, you need to tweak some variables before anything.
45+
46+
1. Duplicate `var-config-example.sh` and rename it as `var-config.sh`
47+
2. Configure your local environment within `var-config.sh`
48+
3. `./run.sh`
49+
4. In your browser, go to `http://localhost:2368/` & `http://localhost:2368/ghost`
50+
51+
That’s it!
52+
53+
54+
## Details
55+
56+
- Executing `./run.sh` runs the `stable` image
57+
- Executing `./runedge.sh` runs the `edge` image
58+
- Executing `./rundown.sh` shutdown the container
59+
- Directory `theme_stable` is where your Ghost Themes are considered stable. You should never copy anything manually in there.
60+
- Directory `theme_tryout` is where you can manually copy theme within. Copy and unzip Ghost theme you want to try here
61+
- Directory `content` is where the Ghost container mount its volume. You should never copy anything manually in there.
62+
63+
64+
## Contributing
65+
66+
Thanks to the power of communities, this is where `1 + 1 = 3`.
67+
68+
1. Fork it
69+
2. Create your feature branch: `git checkout -b my-new-feature`
70+
3. Commit your changes: `git commit -am 'Add some feature'`
71+
4. Push to the branch: `git push origin my-new-feature`
72+
5. Submit a pull request
73+
74+
75+
## Sources & Fork
76+
77+
- This Git repo is available at:<br> https://github.com/firepress-org/ghost-local-dev-in-docker
78+
79+
80+
## License
81+
82+
- This git repo is under the **GNU** license information. [Find it here](https://github.com/pascalandy/GNU-GENERAL-PUBLIC-LICENSE).
83+
- The Ghost’s software, is under the **MIT** license. [Find it here](https://ghost.org/license/).
84+
85+
86+
## FirePress Hosting
87+
88+
**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.
89+
90+
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:
91+
92+
- Montréal - Canada
93+
- Toronto - Canada
94+
- New-York - USA
95+
- Québec City - Canada
96+
97+
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/).
98+
99+
100+
## Keep in touch
101+
102+
- [Pascal Andy’s « now page »](https://pascalandy.com/blog/now/)
103+
- Follow me on [Twitter](https://twitter.com/askpascalandy)
104+
- Find more Ghost Themes on [play-with-ghost.com](https://play-with-ghost.com/)

_my_themes/liebling/LICENSE

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Copyright (c) 2018-2019 Eduardo Gómez
2+
3+
Permission is hereby granted, free of charge, to any person
4+
obtaining a copy of this software and associated documentation
5+
files (the "Software"), to deal in the Software without
6+
restriction, including without limitation the rights to use,
7+
copy, modify, merge, publish, distribute, sublicense, and/or sell
8+
copies of the Software, and to permit persons to whom the
9+
Software is furnished to do so, subject to the following
10+
conditions:
11+
12+
The above copyright notice and this permission notice shall be
13+
included in all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
17+
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
19+
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
20+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22+
OTHER DEALINGS IN THE SOFTWARE.

_my_themes/liebling/README.md

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
# Liebling
2+
3+
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 🌓!
4+
5+
If you use it and you like it, please consider to make a donation to support its development! 🙏🏼
6+
7+
<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>
8+
9+
## Preview
10+
11+
You can see a live demo here: [https://liebling.eduardogomez.io](https://liebling.eduardogomez.io)
12+
13+
![](https://res.cloudinary.com/edev/image/upload/v1570370297/liebling/liebling-promo-ipad.jpg)
14+
<br><br>
15+
![](https://res.cloudinary.com/edev/image/upload/v1570370297/liebling/liebling-promo-mobile.jpg)
16+
17+
## Download
18+
19+
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.
20+
21+
## Features
22+
23+
### General features
24+
25+
* Clean and beautiful design 💅🏼
26+
* Lightning fast ⚡️
27+
* Fully responsive, looks great on any device 📱
28+
* Compatible with modern browsers 💻
29+
* Fast support 📞
30+
31+
### Ghost features
32+
33+
* Subscription form
34+
* Multiple authors
35+
* Logo support
36+
* Featured posts and pages
37+
* Post, Page, Tag, Authors, pages
38+
* Koenig editor
39+
* Bookmark card
40+
* Gallery card
41+
* Blog title and description
42+
* Cover image for Home, Post, Page, Tag, Author pages
43+
* Author avatar, bio, location, website and social links
44+
* Facebook and Twitter social links
45+
* Reading time
46+
* Next and Previous post navigation
47+
* Primary tag in posts
48+
49+
### Liebling unique features
50+
51+
* Dark mode
52+
* Search
53+
* Custom Subscribe page
54+
* Custom authors page
55+
* Custom error page
56+
* Medium style image zoom
57+
* Comments with Disqus
58+
* Share post on Facebook and Twitter
59+
* Slider for featured posts
60+
* Support for normal, wide and full images in posts
61+
* Reading progress indicator
62+
* RTL language support
63+
64+
## Localization
65+
66+
* English
67+
* Spanish
68+
* German by [D3473R](https://github.com/D3473R)
69+
* Informal german by [D3473R](https://github.com/D3473R)
70+
* Bulgarian by [clappingmonkey](https://github.com/clappingmonkey)
71+
* Vietnamese by [hiensarahly](https://github.com/hiensarahly)
72+
* Italian by [vignini](https://github.com/vignini)
73+
* French by [v1nc3nt-fr](https://github.com/v1nc3nt-fr)
74+
* Informal french by [v1nc3nt-fr](https://github.com/v1nc3nt-fr)
75+
* Portuguese by [ivomota](https://github.com/ivomota)
76+
* Arabic by [allamiro](https://github.com/allamiro)
77+
* Polish by [otlet](https://github.com/otlet)
78+
* Brazilian portuguese by [pedrinholula](https://github.com/pedrinholula)
79+
* Russian by [stereohorse](https://github.com/stereohorse)
80+
* Kyrgyz by [januchaos](https://github.com/januchaos)
81+
* Hebrew by [cohen604](https://github.com/cohen604)
82+
83+
## Theme tested
84+
85+
* W3C Markup Validation: [Correct validation](https://validator.w3.org/nu/?doc=https%3A%2F%2Fliebling.eduardogomez.io%2F)
86+
* Ghost GScan: [100/100 points](https://gscan.ghost.org/)
87+
* GTmetrix PageSpeed Score: **A (97%)**
88+
* PageSpeed Insights: **94/100** (mobile) **99/100** (desktop)
89+
* Pingdom Performance Grade: **A 91**
90+
91+
## Theme development
92+
93+
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.
94+
95+
Please take a look to this page to see how it works: https://github.com/eddiesigner/liebling/wiki/Theme-development-with-Docker
96+
97+
## Help and Support
98+
99+
To enable the search, comments, subscribers and so on, you must follow the steps found in the [Wiki](https://github.com/eddiesigner/liebling/wiki).
100+
101+
If you have any questions or troubles with this product, please feel free to open an issue [here](https://github.com/eddiesigner/liebling/issues).
102+
103+
## License
104+
105+
Copyright (c) 2018-2019 Eduardo Gómez. Released under the [MIT license](https://github.com/eddiesigner/liebling/blob/master/LICENSE).
106+
107+
## Credits
108+
109+
All photos I used on this theme are from [Unsplash](https://unsplash.com)

_my_themes/liebling/assets/css/app.css

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
5.39 KB
Binary file not shown.

0 commit comments

Comments
 (0)