Diary Browser

Diary Browser is a web application built with React and TypeScript that allows users to browse and read diary entries. The application is designed to be a single-page application (SPA) and is hosted on GitHub Pages.

You can access the live version of the application at Diary Browser.

Features

• Browse diary entries
• Responsive design
• Skeleton loading for better user experience
• Hosted on GitHub Pages

Technologies Used

• TypeScript
• React
• TailwindCSS
• HeadlessUI
• npm
• clsx

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

• Node.js and npm installed on your machine

Installation

1. Clone the repo

   git clone https://github.com/your-username/diary-browser.git

2. Install NPM packages

   npm install

3. Start the development server

   npm run dev

Usage

1. Open your browser and navigate to http://localhost:5173
2. Browse and read diary entries

Deployment

The application is deployed on GitHub Pages. To deploy your own version, follow these steps:

1. Build the project

   npm run build

2. Deploy to the pages branch manually

Acknowledgements

Special thanks to @rafgraph for providing spa-github-pages, which makes it possible to host this single-page application on GitHub Pages.

License

Distributed under the MIT License. See LICENSE for more information.