This commit is contained in:
@@ -7,4 +7,5 @@ NEXT_SOCIAL_INSTAGRAM="http://instagram.com/rattatwinko" # Your Ins
|
||||
NEXT_SOCIAL_TWITTER="https://twitter.com/user" # I dont have Twitter , if you have put your user there. #
|
||||
NEXT_SOCIAL_GITHUB_STATE="true" # I Have GitHub so this is True (if you dont then set this to false) #
|
||||
NEXT_SOCIAL_GITHUB_LINK_IF_TRUE="http://github.com/ZockerKatze" # If you have GitHub then paste your link here #
|
||||
NEXT_SOCIAL_BUYMEACOFFEE="https://coff.ee/rattatwinko"
|
||||
PORT=8080 # This is unused. You can safely delete if you want. #
|
||||
@@ -69,6 +69,14 @@ Your blog will be available at `http://localhost:3000`
|
||||
|
||||
## 🐳 Docker Deployment
|
||||
|
||||
> **Note:** Docker deployment works very well now, and this is the suggested way of running MarkdownBlog. Folder emojis work perfectly within Docker!
|
||||
>
|
||||
> **Technical details:**
|
||||
> - Docker ensures a consistent environment, eliminating issues with local Node.js, npm, or OS differences.
|
||||
> - All dependencies, file paths, and permissions are managed inside the container, reducing "works on my machine" bugs.
|
||||
> - The Docker volume for `/app/posts` guarantees that your content and emoji settings persist across container restarts and upgrades.
|
||||
> - The API now reads the emoji and pin data fresh on every request, so changes are instantly reflected in the UI.
|
||||
|
||||
### Option 1: Quick Deployment Script
|
||||
|
||||
For a quick and easy deployment, use the included Docker script:
|
||||
@@ -134,6 +142,13 @@ docker-compose up -d
|
||||
|
||||
## Local Deployment
|
||||
|
||||
> **Warning:** Local deployment is now more buggy than the Docker deployment. For the best experience, use Docker.
|
||||
>
|
||||
> **Technical blah:**
|
||||
> - Local runs can be affected by mismatched Node.js versions, missing dependencies, or file permission issues.
|
||||
> - File system events and hot reloads may not always pick up changes to emoji or pin data, leading to stale UI or missing features.
|
||||
> - If you must use local, always restart the server after changing `pinned.json` or folder emoji settings.
|
||||
|
||||
If Docker isn't your thing, here's how to deploy locally:
|
||||
|
||||
### Development Mode
|
||||
@@ -262,6 +277,8 @@ Create a `.env.local` file , or use mine as a template:
|
||||
|
||||
#NEXT_SOCIAL_GITHUB_LINK_IF_TRUE="http://github.com/ZockerKatze" # If you have GitHub then paste your link here
|
||||
|
||||
#NEXT_SOCIAL_BUYMEACOFFEE="https://coff.ee/rattatwinko"
|
||||
|
||||
#PORT=8080
|
||||
```
|
||||
|
||||
@@ -336,6 +353,18 @@ We welcome contributions! Please:
|
||||
|
||||
---
|
||||
|
||||
## ☕ Support the Project
|
||||
|
||||
If you enjoy using MarkdownBlog and want to support its development, you can now [buy me a coffee](https://coff.ee/rattatwinko)!
|
||||
|
||||
Your support helps keep the project alive and motivates further improvements. Thank you!
|
||||
|
||||
> **Tip:** You can change the coffee link by setting the `NEXT_SOCIAL_BUYMEACOFFEE` variable in your `.env.local` file.
|
||||
>
|
||||
> If you hate the developer do this.
|
||||
|
||||
---
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
Thanks for choosing MarkdownBlog! If you find it useful, please:
|
||||
@@ -347,6 +376,14 @@ Thanks for choosing MarkdownBlog! If you find it useful, please:
|
||||
|
||||
---
|
||||
|
||||
## 🗂️ Folder Emoji Technical Note
|
||||
|
||||
- Folder emoji assignments are now stored in `posts/pinned.json` and are read directly by the API on every request.
|
||||
- This means emoji changes are persistent and robust, especially in Docker, where the file system is isolated and predictable.
|
||||
- If you ever see missing emojis, check that your Docker volume is mounted and the JSON file is up to date.
|
||||
|
||||
---
|
||||
|
||||
> **Happy Blogging!** 🎉
|
||||
>
|
||||
> *"DEVELOPERS! DEVELOPERS! DEVELOPERS!"* - Steve Ballmer
|
||||
|
||||
@@ -141,6 +141,20 @@ export default function RootLayout({
|
||||
/>
|
||||
</a>
|
||||
)}
|
||||
{process.env.NEXT_SOCIAL_BUYMEACOFFEE && (
|
||||
<a
|
||||
href={process.env.NEXT_SOCIAL_BUYMEACOFFEE.replace(/(^\"|\"$)/g, '')}
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="h-6 sm:h-8"
|
||||
>
|
||||
<img
|
||||
src="https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black"
|
||||
alt="BuyMeACoffee"
|
||||
className="h-6 sm:h-8"
|
||||
/>
|
||||
</a>
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user