https://github.com/juliankrzysiak/jeblore
A website for hosting jeblore comics
https://github.com/juliankrzysiak/jeblore
art astro cms keystatic webcomic webcomics-platform
Last synced: 6 months ago
JSON representation
A website for hosting jeblore comics
- Host: GitHub
- URL: https://github.com/juliankrzysiak/jeblore
- Owner: juliankrzysiak
- License: other
- Created: 2024-11-13T07:49:29.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-03-24T04:29:37.000Z (7 months ago)
- Last Synced: 2025-03-24T05:28:06.038Z (7 months ago)
- Topics: art, astro, cms, keystatic, webcomic, webcomics-platform
- Language: Astro
- Homepage: https://jeblore.com
- Size: 5.72 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
jeblore
A website for jeblore, a webcomic about living with Jeb and other creatures.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
Desktop Light | Mobile Dark
-------------------------|-------------------------
| 
### Built With
* [![Astro][Astro-shield]][Astro-url]
* [![TypeScript][TypeScript-shield]][TypeScript-url]
* [![Keystatic][Keystatic-shield]][Keystatic-url]
### Features
* Performant static site for hosting webcomics
* Git-based CMS to easily change data
* Simple and accessible design
* Cool theme picker
### How It's Made
I made this website using a static site generator, Astro, because it is perfect for content-focused websites like this for increases performance and pleasant DX. The only JS used is for the theme picker.
I designed the webite to be simple, emulating the simple mind of Jeb, our eponymous main character.
And the simplicity of use and focus on accessibility also leads to better UX.
Kepping in this theme, I wanted the website to be easily updated, so I opted for a git-based CMS, which would just store the images in the repo. All the images are optimized during the build process.
### Learning Outcomes
| The Good | The Bad | The Ugly |
|----------------------------------------|------------------------------------------------------|----------|
| Performance from SSG | Too much time spent on what is the best CMS | |
| Back to Vanilla CSS | Did not have a good time with Decap CMS | |
| Accessibility | URL issues in prod | |
| Theme Picker | | |
## Getting Started
To get a local copy up and running follow the steps.
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
* pnpm
```sh
npm install -g pnpm
```
### Installation
1. Clone the repo
```sh
git clone https://github.com/juliankrzysiak/jeblore.git
```
2. Go to project directory
```sh
cd jeblore
```
3. Install dependencies
```sh
pnpm install
```
4. Start the server
```sh
pnpm start
```
## Usage
You can add new comics or other data by accessing the CMS in dev mode. Start up dev mode then append /keystatic to the home url, eg. `http://127.0.0.1:4321/`.
The default storage mode is local, but this can be [changed to github](https://keystatic.com/docs/github-mode) to allow for others with write permission to the repo to change data.
```js
export default config({
storage: {
kind: 'github',
}
})
```
For an easier option for non-tecnical clients, one can change the [storage mode to cloud](https://keystatic.com/docs/cloud).
You can easily change the structure of the data by going to `keystatic.config.ts` and modifying what you would like.
I am hosting this on Cloudflare Pages, so you can get rid of the adapter in `astro.config.mjs` if you hosted elsewhere.
## Contributing
Contributions 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 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!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
### Top contributors:
## License
Distributed under the MIT license EXCEPT for any images / assets. See `LICENSE.txt` for more information.
## Contact
Julian Krzysiak - jkrzysiak13@gmail.com
Project Link: [https://github.com/juliankrzysiak/jeblore](https://github.com/juliankrzysiak/jeblore)
## Acknowledgments
* [Favicon Generator](https://favicon.io/)
* [Making the theme picker accessible](https://fossheim.io/writing/posts/accessible-theme-picker-html-css-js/)
[contributors-shield]: https://img.shields.io/github/contributors/juliankrzysiak/jeblore.svg?style=for-the-badge
[contributors-url]: https://github.com/juliankrzysiak/jeblore/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/juliankrzysiak/jeblore.svg?style=for-the-badge
[forks-url]: https://github.com/juliankrzysiak/jeblore/network/members
[stars-shield]: https://img.shields.io/github/stars/juliankrzysiak/jeblore.svg?style=for-the-badge
[stars-url]: https://github.com/juliankrzysiak/jeblore/stargazers
[issues-shield]: https://img.shields.io/github/issues/juliankrzysiak/jeblore.svg?style=for-the-badge
[issues-url]: https://github.com/juliankrzysiak/jeblore/issues
[license-shield]: https://img.shields.io/github/license/juliankrzysiak/jeblore.svg?style=for-the-badge
[license-url]: https://github.com/juliankrzysiak/jeblore/blob/main/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/juliankrzysiak
[product-screenshot]: public/jb-og.png
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[Next-url]: https://nextjs.org/
[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
[React-url]: https://reactjs.org/
[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
[Svelte-url]: https://svelte.dev/
[Astro-shield]: https://img.shields.io/badge/Astro-000000?style=for-the-badge&logo=astro&logoColor=BC52EE
[Astro-url]: https://astro.build/
[TypeScript-shield]: https://img.shields.io/badge/TypeScript-3178c6?style=for-the-badge&logo=typescript&logoColor=ffffff
[TypeScript-url]: https://www.typescriptlang.org/
[Keystatic-shield]: https://img.shields.io/badge/Keystatic-ffffff?style=for-the-badge&logo=keystone&logoColor=000000
[Keystatic-url]: https://keystatic.com/