search

Cryptizism / skin-overlay

A Minecraft Skin overlay website that allows you to put accessories and overlays on your character
https://cryptizism.github.io/skin-overlay/
GNU General Public License v2.0
7 stars 0 forks source link
astro gh-pages minecraft minecraft-skin react

readme

Skin Overlay Website

shield shield shield GitHub Workflow Status (with event)

Welcome to the Skin Overlay project! This is an open-source website that allows you to add overlays to your Minecraft skins, such as hats, clothing, and more. The project is built on Astro and is deployed using GitHub Pages.

Website Features

Contributing

We welcome contributions from the community to enhance the website's functionality and add new features. If you're interested in contributing but are unfamiliar with GitHub, don't worry! You can dm me on Discord: Cryptizism and I'll get everything added for you.

How to Run Locally

  1. Clone the repository:

    git clone https://github.com/Cryptizism/skin-overlay.git

  2. Navigate to the project directory:

    cd skin-overlay

  3. Install dependencies:

    npm install

  4. Start the local development server:

    npm run dev

The website will now be running locally at http://localhost:3000.

Deployment

The website is automatically deployed using GitHub Pages. Any changes merged into the main branch will be automatically published and visible at https://cryptizism.github.io/skin-overlay/.