Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AlexSciFier/neonlink
Simple self-hosted bookmark service.
https://github.com/AlexSciFier/neonlink
Last synced: 2 months ago
JSON representation
Simple self-hosted bookmark service.
- Host: GitHub
- URL: https://github.com/AlexSciFier/neonlink
- Owner: AlexSciFier
- License: mit
- Created: 2022-04-19T06:03:03.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-31T08:47:01.000Z (5 months ago)
- Last Synced: 2024-01-31T09:58:39.121Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 2.92 MB
- Stars: 236
- Watchers: 5
- Forks: 12
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-selfhosted - NeonLink - Self-hosted bookmark service with unique design and simple installation with Docker. `MIT` `Docker` (Software / Bookmarks and Link Sharing)
- awesome-stars - AlexSciFier/neonlink - Simple self-hosted bookmark service. (JavaScript)
- awesome-stars - AlexSciFier/neonlink - Simple self-hosted bookmark service. (JavaScript)
- awesome-stars - AlexSciFier/neonlink - Simple self-hosted bookmark service. (JavaScript)
- awesome-stars - AlexSciFier/neonlink - Simple self-hosted bookmark service. (JavaScript)
- awesome-selfhosted - NeonLink - Self-hosted bookmark service with unique design and simple installation with Docker. `MIT` `Docker` (Software / Bookmarks and Link Sharing)
- fucking-awesome-selfhosted - NeonLink - Self-hosted bookmark service with unique design and simple installation with Docker. `MIT` `Docker` (Software / Bookmarks and Link Sharing)
- awesome-stars - AlexSciFier/neonlink - Simple self-hosted bookmark service. (JavaScript)
- awesome-selfhosted - NeonLink - Self-hosted bookmark service with unique design and simple installation with Docker. `MIT` `Docker` (Software / Bookmarks and Link Sharing)
README
## Overview
- [Introduction](#introduction)
- [Features](#features)
- [Screenshots](#screenshots)
- [Installation](#installation)
- [Development](#development)
## Introduction
NeonLink is a simple and open-source self-hosted bookmark service. It is lightweight, uses minimal dependencies, and is easy to install via Docker. Due to the low system requirements, this application is ideal for deployment on the RaspberryPI.
## Features
- Tags
- Search
- Auto icon, title, description
- Customizable background
- Lightweight
- Private
- Dashboard
## Installation
### With Docker
[DockerHub](https://hub.docker.com/r/alexscifier/neonlink)
You can easily install an application using Docker. The images are also optimized for RaspberryPi.
Then run the command which will install the Docker container.
```sh
docker run -p {80}:3333 -v {/path/to/data}:/app/data -v {/path/to/backgrounds}:/app/public/static/media/background alexscifier/neonlink:latest
```
- Replace {80} with any port you like.
- Replace {/path/to/data} with the path to the data folder with private data
- Replace {/path/to/backgrounds} with the path to the background images folder
Or you can install with `docker-compose.yml` file
```sh
#clone repo
git clone https://github.com/AlexSciFier/neonlink.git
cd neonlink
#edit doker-compose.yml and run docker compose
docker-compose up -d
```
## Development
This project is open source, so you can change it or contribute. The application consists of two parts. The frontend is based on the [React](https://reactjs.org/) framework. The server part is based on the [Fastify](https://www.fastify.io/) framework. [Sqlite](https://www.sqlite.org/index.html) is used as a data base and its implementation for Nodejs is [better-sqlite3](https://github.com/WiseLibs/better-sqlite3).
This project requires Nodejs and npm.
For Windows development, it is recommended to use git bash.
### Setup
```sh
# Clone project
git clone https://github.com/AlexSciFier/neonlink.git
cd neonlink
# Install fastify-cli
npm install fastify-cli --global
# Run once to install dependencies
npm run dev-init
# Run dev server
npm run dev-start
```
## Build
Neonlink uses multiarch build. That means you need to use [buildx](https://docs.docker.com/engine/reference/commandline/buildx_build/). Or you can use [BuildKit](https://docs.docker.com/build/buildkit/) to build image for one platform.
To build your own docker container run in root folder
### Build multiarch image
```sh
docker buildx build --platform linux/arm/v7,linux/amd64 --push --tag alexscifier/neonlink:latest .
```
### Build for one platform
```sh
# Linux shell
DOCKER_BUILDKIT=1 docker build --tag alexscifier/neonlink:latest .
```
```sh
# Windows PowerShell
$env:DOCKER_BUILDKIT=1; docker build -t alexscifier/neonlink .
```
## Screenshots
