StoryPad Website

Not another journal app. A timeline for your life.

---

About This Repository

This repository contains the source code for the StoryPad website (storypad.me) - the official documentation, changelog, and marketing site for the StoryPad open-source diary app.

Looking for the main StoryPad app? Visit the main repository for the Flutter-based mobile application.

About StoryPad

StoryPad is an open-source timeline diary app with 80,000+ downloads that lets you capture everything - notes, thoughts, emotions, workouts, travels - on a single continuous timeline.

Key Features

• Timeline-based journaling - No folders, no tabs, just your life beautifully organized
• Multi-platform - Available on iOS and Android
• Open source - Built with Flutter and available on GitHub
• Privacy-focused - Your data belongs to you
• Multilingual - Support for 16+ languages

Technology Stack

This website is built with:

• Hugo - Static site generator
• Tailwind CSS - Utility-first CSS framework
• Custom Theme - sp_theme designed specifically for StoryPad
• GitHub Pages - Automated deployment

Development Setup

Prerequisites

• Node.js (for Tailwind CSS)
• Hugo Extended (included in repository as hugo.tar.gz)

Getting Started

1. Clone the repository

   git clone https://github.com/theachoem/storypad.me.git
   cd storypad.me

2. Install dependencies

   npm install

3. Extract Hugo binary (if not already done)

   tar -xzf hugo.tar.gz

4. Start development server

   ./hugo server --buildDrafts --buildFuture

5. Visit http://localhost:1313 to view the site

Building for Production

./hugo --gc --minify

The built site will be available in the public/ directory.

Project Structure

├── content/              # Markdown content files
│   ├── changelogs/      # App version changelogs
│   ├── contributions/   # Contribution guides
│   ├── engineering/     # Technical blog posts
│   └── wiki/           # Documentation
├── themes/sp_theme/     # Custom Hugo theme
│   ├── layouts/        # HTML templates
│   └── assets/        # CSS, JS, and other assets
├── static/             # Static files (images, icons, etc.)
├── hugo.toml          # Hugo configuration
└── package.json       # Node.js dependencies

Contributing

We welcome contributions to improve the StoryPad website! Here are ways you can help:

Content Contributions

• Documentation improvements - Help make our guides clearer
• Translation - Contribute to our localization efforts
• Blog posts - Share your StoryPad experience

Technical Contributions

• Bug fixes - Help us fix website issues
• Feature improvements - Enhance the website experience
• Performance optimizations - Make the site faster

How to Contribute

1. Fork this repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Reporting Issues

Found a bug or have a suggestion? Please:

• Check if the issue already exists in our issue tracker
• For app-related issues, use the main app repository
• For website issues, create an issue in this repository

Links

• Main App Repository: github.com/theachoem/storypad
• Website: storypad.me
• iOS App: App Store
• Android App: Google Play
• Contact: [email protected]

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Acknowledgments

• Built with ❤️ by theachoem
• Powered by Hugo and Tailwind CSS
• Thanks to all contributors and the StoryPad community

---

StoryPad - Your timeline, your story