compositr/luciders
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Dynamically serving up lucide icons
36 commits 3 branches 4 tags 114 KiB
Rust 98.3%
Dockerfile 1.7%
Find a file
Compositr 45e257e101 deps: i didn't need regex
2024-11-02 18:30:25 +11:00
.config/cspell feat: accept commonwealth spelling 2024-11-02 18:17:02 +11:00
src enhance: docs! 2024-11-02 18:24:57 +11:00
vendor deps: add lucide submodule 2024-11-01 20:21:18 +11:00
.gitignore Initial commit 2024-10-30 07:58:10 +11:00
.gitmodules deps: add lucide submodule 2024-11-01 20:21:18 +11:00
Cargo.lock deps: i didn't need regex 2024-11-02 18:30:25 +11:00
Cargo.toml deps: i didn't need regex 2024-11-02 18:30:25 +11:00
cspell.config.yaml Initial commit 2024-10-30 07:58:10 +11:00
LICENSE.md chore: AGPL-3.0 2024-11-02 18:29:58 +11:00
README.md chore: AGPL-3.0 2024-11-02 18:29:58 +11:00

README.md

luciders Server

Dynamically serving up lucide icons. Powered by 🦀 Rust!

Please see /info endpoint handler in src/main.rs for more API details.

Setup Instructions

You will want a copy of the icons dir from the Lucide Github Repo in the root of this project. If you are developing this project, you can simply clone the configured submodule:

git submodule update --init --recursive

If you are deploying to production, you can provide a directory path in the first argument to the binary. For example, if you have the icons in /var/www/icons:

./luciders /var/www/icons

Only .svg files will be read from that directory. The server's default port is 7878, although this can be configured with the PORT environment variable.

License

Please see the LICENSE.md file in this directory. This project is licensed under the AGPL-3.0 license.

Additionally: You may host this project on your own server, and host it for others. You may then use that server in your own projects (e.g. as an API endpoint), even if that project is closed-source or proprietary. However, any modifications to this project must be made available under the AGPL-3.0 license. This is to ensure that the project remains open-source and free for all to use.