Skip to content

Latest commit

 

History

History
95 lines (60 loc) · 3.38 KB

README.md

File metadata and controls

95 lines (60 loc) · 3.38 KB
Raw
forthebadge logo

Looking to submit a badge to be hosted on our site?

To submit a badge, simply visit our official generator create the badge and click "Submit to Approval". Once approved, it joins our collection for all to use. We allow both signed-in and non-signed-in users to submit badges for approval. Signed-in users have the added benefit of tracking the approval status of their submissions.

For standard users

To explore our unique collection and generate badges, simply visit our official website. Our site is designed to enrich your experience with an array of features and services, all dedicated to badges.

For advanced users

We have open-sourced our badge generator so you can self-host and run our classic generator! It all started with our obsession for badges, and it ends with badges for badges' sake.

We have posted a tutorial on our youtube channel that walks through how to setup this project, you can view it here

A hosted verison of this open source generator can be found here

Running Locally

To run For the Badge on your local computer, follow these simple steps:

  1. Clone the repository:

    git clone https://github.com/forthebadge/for-the-badge.git
cd for-the-badge

  2. Install the project dependencies using npm:

    npm install

  3. Start the local server using Vite:

    npx vite

  4. The badge generator will be available at http://localhost:5173. You can access it through your web browser.

  5. To build the project for production:

    npx vite build

Using Docker

You can run For the Badge using Docker in two different ways. Choose the method that best suits your needs:

Method 1: Pull and Run the Docker Image

Use this method if you want to quickly run the latest stable version of For the Badge without building it yourself.

  1. Pull the Docker image from our repository:

    docker pull forthebadge/forthebadge

  2. Run the Docker image:

    docker run -p 8080:8080 forthebadge/forthebadge

Method 2: Build and Run the Docker Image Yourself

This method is ideal if you have downloaded the source code and wish to build the Docker image yourself, perhaps for development or testing purposes.

  1. Build the Docker image:

    docker build -t for-the-badge .

  2. Run the Docker image:

    docker run -p 8080:8080 for-the-badge

Regardless of the method chosen, The badge generator will be available at http://localhost:8080. You can access it through your web browser.

Want to Contribute?

Contributions are welcome and keep this project going! If you'd like to contribute, please fork the repository, make your changes, and submit a pull request. Your contributions may be featured on our official site!

License

This project is licensed under the GNU General Public License v3.0 - see the COPYING file for details.