Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.19 KB

README.md

File metadata and controls

43 lines (27 loc) · 1.19 KB
Raw

Shakō

Shakō: A sleek, modern linktree alternative built with Astro and React. Easily customizable and self-hostable, with an optional hosted version available at keksiqc/shako.me.

Tech stack

  • Astro
  • React
  • Tailwind CSS
  • Shadcn/UI
  • Lanyard

Note

To integrate your Discord user data with Shakō, you must join the Lanyard Discord Server.

Usage

Clone the repository

git clone https://github.com/keksiqc/shako

cd shako

npm install
npm run dev

Edit the configuration

Edit the shako.config.ts file to add your links. The icon prop corresponds to the icon name from Simple Icons. Ensure the icon name matches exactly with the one listed on the Simple Icons website for proper rendering.

Note

Please follow the official Astro documentation if you want to deploy this project.

License

Shakō is licensed under the GPL-3.0 License - see the LICENSE file for details.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.