40 lines
1.8 KiB
Markdown
40 lines
1.8 KiB
Markdown
# Socialtree
|
|
*The awesome and damn simple, selfhosted alternative to linktree*
|
|
---
|
|
[](https://www.javascript.com)
|
|
[](https://dev.cat-enby.club/Nikurasu/socialtree-js/raw/branch/main/LICENSE.txt)
|
|
[](https://www.youtube.com/watch?v=oPTwBv9lvhw)
|
|
|
|
- [TODO](#todo)
|
|
- [Setup](#setup)
|
|
- [Build your own Themes](#build-your-own-theme)
|
|
|
|
## TODO:
|
|
- [X] working template
|
|
- [ ] overwrites of default themes with css `!important` for round profile-pic etc.
|
|
- [ ] more themes
|
|
- [ ] more variations of the themes in version 1.0
|
|
- [X] Dockerize
|
|
|
|
### TODO until 1.0:
|
|
- [X] Import my themes from the old socialtree
|
|
- [X] Overwrite for round profile pictures
|
|
- [X] Testing if everything works like expected
|
|
- [ ] Expand Documentation
|
|
- [ ] Rewrite README
|
|
|
|
## Setup
|
|
A up to date docker image is provided at my gitea, but you can also build it yourself.
|
|
|
|
### Build
|
|
1. Clone the repository `git clone https://git.oishi-ra.men/Nikurasu/socialtree-js.git`
|
|
2. Copy .env.example to .env and edit it to your needs
|
|
3. Build the image. For unix like systems I provide a bash script in `dev/shell/docker-prod.sh`. I hated the hassle to type the full command every time ;)
|
|
|
|
### Deploy
|
|
1. Done with docker-compose. Use the file at `dev/docker/stacks/main/compose.yml` and edit it to your needs.
|
|
2. Configure the resulting config.yml file under your mounted assets volume `config/config.yml` and replace the profile pic in the img folder `img/profilepic.jpg`.
|
|
The image name can be ajusted in the config file if needed.
|
|
|
|
## Build your own theme
|
|
1. Create a new scss file with the themes name in `/src/public/themes` |