GithubHelp home page GithubHelp logo

soulteary / flare Goto Github PK

View Code? Open in Web Editor NEW
138.0 3.0 39.0 3.18 MB

🏂 Challenge all bookmarking apps and websites directories, Aim to Be a best performance monster.

Home Page: https://soulteary.com/2022/02/23/building-a-personal-bookmark-navigation-app-from-scratch-flare.html

License: GNU Affero General Public License v3.0

Go 85.78% CSS 0.38% HTML 13.77% Shell 0.06%
self-hosted bookmarks start-page

flare's Introduction

Flare

Challenge all bookmarking apps and websites directories, Aim to Be a best performance monster.

🚧 Code is being prepared and refactored, commits are slow.

Feature

Simple, Fast, Lightweight and super Easy to install and use.

  • Written in Go (Golang) and a little Modern vanilla Javascript only.
  • Doesn't depend any database or any complicated framework.
  • Single executable, no dependencies required, good docker support.
  • You can choose whether to enable various functions according to your needs: offline mode, weather, editor, account, and so on.

ScreenShot

TBD

Documentation

TBD

  • Browse automatically generated program documentation:
    • godoc --http=localhost:8080

Directory

├── build                   build script
├── cmd                     user cli/env parser
├── config                  config for app
│   ├── data                    data for app running
│   ├── define                  define for app launch
│   └── model                   data model for app
├── docker                  docker
├── embed                   resource (assets, template) for web
├── internal
│   ├── auth                user login
│   ├── fn                  fn utils
│   ├── logger              logger
│   ├── misc
│   │   ├── deprecated
│   │   ├── health
│   │   └── redir
│   ├── pages
│   │   ├── editor
│   │   ├── guide
│   │   └── home
│   ├── resources           static resource after minify
│   ├── server
│   ├── settings
│   └── version
└── main.go

flare's People

Contributors

dependabot[bot] avatar soulteary avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

flare's Issues

v0.4.2 版本计划发布

v0.4.2 计划 12.7 发布

  • 修复因 Go Releaser 版本更新,导致的构建失败的问题。

此版本发布后,将开始构建 v0.5.0 版本,集中解决积累 issue 和完成模版功能。

自定义主题

  • 支持用户使用配置或参数设置主题
    • 支持用户设置锁定程序使用主题
    • 支持用户设置自定义主题
  • 读取和解析主题文件
  • 页面渲染
    • 设置页面
    • 工具首页
    • 帮助页面
  • 将主题目录内容转换为可访问资源
  • 分别处理不同的渲染模式
    • 默认的静态模式
    • #56
    • SSG 模式

【2023年3月7日】部署服务过程中出现文件路径错误

控制台输出的报错结果如下:
internal/editor/editor.go:22:12: pattern editor-assets: no matching files found
internal/guide/guide.go:21:12: pattern guide-assets: no matching files found

引起报错的代码是embed包给出的路径错误;
internal目录下editor.go和guide.go无法找到editor-assets和guide-assets资源文件

没学go语言,所以找不到根源在哪,不断试错才找到一个解决办法,全程表述如果有误请见谅,方法如下:
flare/embed/vendor/editor-assets移动到/flare/internal/editor/editor-assets
flare/embed/vendor/guide-assets移动到/flare/internal/guide/guide-assets
再运行go run main.go即可正常运行服务

详细部署过程及解决方式参考:https://zhuanlan.zhihu.com/p/611890668?

[1/4] 重构,迎接新版本

新版本主要功能规划

  1. 保持快速响应和最小资源占用的前提下,确保程序整体单元测试覆盖 90%
  • 进行中,需要对部分程序进行调整,以便利于测试。
  1. 自定义主题:修改、刷新、生效
  1. 体验更好的“后台编辑”

  2. 更简单的程序参数设置

  3. 支持静态化结果生成,能够部署在任意静态空间,如: GitHub Pages.

auto add favicon.ico

if some website has it's own icon, server can automatically download icon file

[功能建议]API: 添加书签

添加一个用于添加书签的API,使其可以与第三方程序交互,例如快捷指令或者自己写的浏览器拓展。

另一个开源的书签软件linkding的API文档,linkding的速度太慢了,但是其API很好用。

既然是HomeLab使用,那么也不是很需要鉴权,或者加一个简单的access token校验(当然也可以让用户自己用authelia之类的服务实现)。

功能反馈:部署到github page

是否可以实现类似page部署,github自动化部署,页面占用非常小,github或者cf的page完全能满足公网导航页的使用

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.