https://github.com/gopine/diary-browser
Navigate through my memories effortlessly
https://github.com/gopine/diary-browser
clsx headlessui react spa tailwindcss typescript
Last synced: 7 months ago
JSON representation
Navigate through my memories effortlessly
- Host: GitHub
- URL: https://github.com/gopine/diary-browser
- Owner: gopine
- Created: 2025-02-24T06:58:58.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2025-02-24T09:26:43.000Z (7 months ago)
- Last Synced: 2025-02-24T10:22:00.936Z (7 months ago)
- Topics: clsx, headlessui, react, spa, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://gopine.github.io/diary-browser
- Size: 612 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://gopine.github.io/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
```sh
git clone https://github.com/your-username/diary-browser.git
```
2. Install NPM packages
```sh
npm install
```
3. Start the development server
```sh
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
```sh
npm run build
```
2. Deploy to the `pages` branch manually
## Acknowledgements
Special thanks to [@rafgraph](https://github.com/rafgraph) for providing [spa-github-pages](https://github.com/rafgraph/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.