Code Monkey home page Code Monkey logo

homepage's Introduction

Homepage

Build and release Docker image

A self-hosted homepage for your browser with search, quick links and in the future widgets.

Installation

Docker (recommended)

docker run -p 3000:3000 -e CONFIG_FILE=/config.yml -v /home/simon/config.yml:/config.yml ghcr.io/simse/homepage:main

From source

git clone [email protected]:simse/homepage.git
cd homepage
export CONFIG_FILE=/home/simon/config.yml
yarn
yarn start

Configuration

Here is a sample config file:

general:
  locale: en-US
  title: Sorensen Cloud

search:
  enabled: true
  provider: duckduckgo

links:
  - name: Radarr
    url: http://radarr.internal.sorensen.cloud
    image: radarr
  - name: Sonarr
    url: http://sonarr.internal.sorensen.cloud
    image: sonarr
  - name: CouchPotato
    url: http://couchpotato.internal.sorensen.cloud
    image: http://couchpota.to/media/images/full.png

Contributing

Pull requests are welcome. For all changes please open a discussion. For bug fixes it is sufficient to open an issue.

Please make sure to update tests as appropriate.

License

GNU GPLv3

homepage's People

Contributors

simse avatar

Watchers

avatar

homepage's Issues

Set up demo

As a potential user, I'd like to see the project in action, so I can decide whether to set it up for myself

Write readme

As a user I'd like to be able to set up my own homepage using only information available in the README, so I don't have to search for docs any other place

Add PR checks

As a developer, I'd like to know if a PR can be merged without causing issues

Checks to implement:

  • Lint
  • Types
  • Jest
  • E2E (Cypress)
  • Lighthouse

Add Jest testing framework

As a developer I would to catch regressions before they enter the main branch so I don't embarrass myself

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.