Skip to content

I have tried to reprogramme killedby.tech. My aim was to make it as customisable as possible. You can easily add new companies, customise existing ones and add new projects. You can also edit the footer.

License

Notifications You must be signed in to change notification settings

BachErik/killedby

Repository files navigation

Killed by

Killed by is an engaging web application designed to showcase discontinued projects, products, and services, providing insights into their lifecycle and impact. Utilizing data from a specific GitHub repository, this application presents the information in an accessible web interface, emphasizing user-friendly navigation and detailed project breakdowns.

Features

  • Data-Driven Insights: Automatically fetches and displays comprehensive details about discontinued projects, including their initiation and termination dates.
  • Dynamic Grouping: Organizes projects by year and company for easy browsing.
  • Responsive Design: Ensures that logos and project cards maintain their aspect ratios and are displayed correctly across devices.
  • Customization: Easily configured through environment variables to suit different deployment needs.

Live Demo

You can view a live demo of the application at: killedby.bacherik.de

Getting Started

Prerequisites

Before setting up the project, ensure you have Docker and Git installed on your system. These tools are necessary for running the application in a containerized environment.

Installation

  1. Clone the Repository: Begin by cloning the template repository to create your own project setup:

    git clone https://github.com/BachErik/killedby.json your-project-name
    cd your-project-name

    [!NOTE] If you want to automatically update your repo cache on changes make sure you have the GitHub action configured correctly to your domain and set the UPDATE_TOKEN

  2. Docker Setup: Build and run the Docker container:

    docker build -t yourusername/killedby .
    docker run -d -p 8080:8080 -e GITHUB_USERNAME=yourusername -e GITHUB_REPOSITORY=your-repo.json -e UPDATE_TOKE=someSaveToken yourusername/killedby

Usage

Once the application is running, access it by navigating to http://localhost:8080 in your web browser. Explore the discontinued projects by company or year, and gain insights into various trends and historical data points across different industries.

Configuration

Modify the following environment variables as needed to point to different data sources or customize the application behavior:

  • GITHUB_USERNAME: Username of the GitHub account where the data repository is located.
  • GITHUB_REPOSITORY: Name of the repository containing JSON files with project data.
  • UPDATE_TOKEN: This toke is used in the /update POST request for authentication that an authorized request to update the repo cache.

Contributing

Contributions are welcome! If you have suggestions for improvements or bug fixes, please fork the repository and submit a pull request.

License

This project is open-sourced under the MIT License. See the LICENSE file for more details.

About

I have tried to reprogramme killedby.tech. My aim was to make it as customisable as possible. You can easily add new companies, customise existing ones and add new projects. You can also edit the footer.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks