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.
- Browse diary entries
- Responsive design
- Skeleton loading for better user experience
- Hosted on GitHub Pages
- TypeScript
- React
- TailwindCSS
- HeadlessUI
- npm
- clsx
To get a local copy up and running, follow these simple steps.
- Node.js and npm installed on your machine
- Clone the repo
git clone https://github.com/your-username/diary-browser.git
- Install NPM packages
npm install
- Start the development server
npm run dev
- Open your browser and navigate to
http://localhost:5173 - Browse and read diary entries
The application is deployed on GitHub Pages. To deploy your own version, follow these steps:
Deploy to the pages branch manually or use the deploy script:
npm run deployContributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this project better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Special thanks to @rafgraph for providing spa-github-pages, which makes it possible to host this single-page application on GitHub Pages.
Distributed under the MIT License. See LICENSE for more information.