Giter VIP home page Giter VIP logo

colly's Introduction

Colly app logo

Colly

Web-based Website URL Collection app


Package version Build status License

Description | Usage | Contribution | License

๐Ÿ“™ Description

Colly is a web-based application designed for effortlessly collecting and organizing your favorite URL's and websites. With Colly, users can create a personalized library of web pages.

One of Colly's features is its tagging system, which allows users to categorize and organize their collections with ease. Whether it's articles, blogs, tutorials, or any other web content, users can assign relevant tags to each link, enabling efficient retrieval and navigation within their collections.

The collection of a user can also be set as public and accessed using a public access link by anyone who has the link.

Whether you're a student, professional, or simply someone who loves to explore the web, Colly empowers users to create curated collections tailored to their unique preferences and interests. Say goodbye to scattered bookmarks and hello to a more organized, accessible, and enjoyable web browsing experience with Colly.

Screenshots

Screenshot of Colly login page

Colly item dashboard

Item edit view

๐Ÿ–ฅ Usage

Setup & requirements

The back-end of the application is written using Node.js and the Express framework, while the front-end part uses React.

As dependencies, a MongoDB database and an S3-compatible object storage, such as MinIO, are required. Its access credentials need to be configured using the environment variables below.

Deploy using Docker

The recommended way to deploy Colly is using its Docker image.

The image can be pulled from the GitHub Packages registry using: docker pull ghcr.io/jarne/colly:latest.

Environment variables

The following environment variables can be set:

Env variable Default Value Description
MONGO_HOST Hostname of MongoDB
MONGO_PORT 27017 Port of MongoDB
MONGO_DB MongoDB database name
JWT_SECRET Random secret for JWT
EXPIRES_IN_SEC 86400 Expiration of JWT (in seconds)
INITIAL_ADMIN_USERNAME Create initial admin user with this username
INITIAL_ADMIN_PASSWORD Password for initial admin user
LOG_LEVEL info Log level of the app
LOKI_HOST Hostname for Grafana Loki to send logs to
LOKI_BASIC_AUTH Authentication credentials (basic auth format) for Grafana Loki
S3_ENDPOINT Hostname for S3-compatible endpoint for image storage
S3_REGION S3 region to use
S3_ACCESS_KEY Access key ID for S3 endpoint
S3_ACCESS_SECRET Secret access key for S3 endpoint
S3_BUCKET Name of the S3 bucket

๐Ÿ™‹โ€ Contribution

Contributions are always very welcome! It's completely equal if you're a beginner or a more experienced developer.

Thanks for your interest ๐ŸŽ‰๐Ÿ‘!

๐Ÿ‘จโ€โš–๏ธ License

MIT

colly's People

Contributors

jarne avatar renovate[bot] avatar

Watchers

 avatar  avatar

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.