Overview
Markdown Today is a web-based journal application that allows users to store and edit their journal entries as markdown files on Dropbox. It provides a convenient and accessible way to access your journal from any browser.
Features
- Optimized for mobile: The application is designed to work smoothly on mobile browsers while still providing an excellent user experience on desktop.
- Serverless: Markdown Today does not require a server, offering increased security and reducing the need to trust third-party services.
- Dropbox integration: Users can connect their Dropbox account to automatically sync and store their journal entries.
- Optional AES encryption: For enhanced security, Markdown Today also offers the option to encrypt journal entries using the Stanford JavaScript Crypto Library.
Installation
- Clone the Markdown Today repository from GitHub.
- Run
npm installto install dependencies. - Obtain your own Dropbox Client ID by registering your fork of the app on the Dropbox My Apps page.
- Update the
src/constants.jsfile to include your new Client ID and redirect URL. - Configure your web server to serve
index.htmlfor all potential requests. - Run the development server using
npm start, run tests withnpm test, and build the production bundle usingnpm run build. - If you wish to deploy the application to your own server, use
npm run deploy(Note: SSH access to the server is required).
Summary
Markdown Today is a journal application that leverages the power of markdown and Dropbox to provide a simple and secure way to store and edit journal entries. With its mobile optimization, serverless architecture, and optional encryption, Markdown Today offers a user-friendly solution for journaling needs.