Skip to content

juliankrzysiak/jeblore

Repository files navigation

Contributors Forks Stargazers Issues MIT LinkedIn


Logo

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
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

Desktop Light Mobile Dark
Desktop screenshot Mobile screenshot

(back to top)

Built With

  • Astro
  • TypeScript
  • Keystatic

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

(back to top)

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
    npm install -g pnpm

Installation

  1. Clone the repo
    git clone https://github.com/juliankrzysiak/jeblore.git
  2. Go to project directory
    cd jeblore
  3. Install dependencies
    pnpm install
  4. Start the server
    pnpm start

(back to top)

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 to allow for others with write permission to the repo to change data.

export default config({
	storage: {
		kind: 'github',
	}
})

For an easier option for non-tecnical clients, one can change the storage mode to 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.

(back to top)

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

(back to top)

Top contributors:

contrib.rocks image

License

Distributed under the MIT license EXCEPT for any images / assets. See LICENSE.txt for more information.

(back to top)

Contact

Julian Krzysiak - jkrzysiak13@gmail.com

Project Link: https://github.com/juliankrzysiak/jeblore

(back to top)

Acknowledgments

(back to top)