Skip to content

IhsenBouallegue/HubOne

Repository files navigation

Hub One - The Heart of All Your Team’s Bookmarks.
Explore the screenshots »

Report a Bug · Request a Feature . Ask a Question
Table of Contents

About

Tired of keeping track of new tools and websites? Tired of having to update your bookmarks every few weeks if not days? Access all bookmarks from this one page. Everything is up to date. No need to clutter your life anymore! Hub One is a self hosted web app that aims to solve the problem of syncing tools and useful links between team members. It does one thing really really well!

Screenshots

Hero Section Links Section

Built With

Hub One is built with the amazing Nextjs framework that in turn is based on React. The beautiful UI components are built using Mantine UI. It uses PostgresSQL as a database for all the links and bookmarks. With the help of Prisma -a database ORM- quereying is a breeze and totally database-agnostic. For deployment we used Docker to create containers that are easily deployable (for development and prodcution).

Getting Started

Prerequisites

To run Hub One locally you will need:

  • Nodejs: A JavaScript runtime.
  • Yarn: A package manager for JavaScript.
  • Docker Desktop: For running the containers locally.

Installation

# Clone the github repo
git clone https://github.com/IhsenBouallegue/hub-one
# Install the dependencies
yarn install

Usage

We have set up yarn scripts that will use docker compose files to launch the Hub One container and the PostgreSQL Database.

# Laucnh development containers
yarn up
# Launch production containers
yarn up:prod

Roadmap

See the open issues for a list of proposed features (and known issues).

Support

Reach out to the maintainer at one of the following places:

Project assistance

If you want to say thank you or/and support active development of Hub One:

  • Add a GitHub Star to the project.
  • Tweet about Hub One.
  • Write interesting articles about the project on Dev.to, Medium or your personal blog.

Together, we can make Hub One better!

Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

Authors & contributors

The original setup of this repository is by Ihsen Bouallegue.

For a full list of all authors and contributors, see the contributors page.

License

This project is licensed under the MIT license.

See LICENSE for more information.

Acknowledgements

Special thanks goes to MaibornWolff for supporting the development of this project and being open to adopting it company-wide.