if/littlelink-server
1
0
Fork 0
mirror of https://github.com/techno-tim/littlelink-server.git synced 2025-03-04 16:08:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add contribution guide for adding new buttons (#384)

Browse Source
This commit is contained in:
Jan Dittrich 2023-05-04 02:53:03 +02:00 committed by GitHub
parent e78943c7a5
commit 7c4e012c2d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
CONTRIBUTION.md Normal file
View File

@ -0,0 +1,24 @@
# Contribution Guide
This guide will help you set up an local development environment and give you some tips how to contribute new buttons configurations to this project.
## Local Development Environment
### Local Container
1. Make sure to have a running docker installation
2. `docker compose up --build`
3. Access the local container via http://localhost:8080
## Contributing
### Add new button
1. Choose a meaningful name for the service you are adding. Make sure to use the same name everywhere.
2. Add button class in `public/css/brands.css`. Make sure the background/font color matching the logo.
3. Put the logo as SVG into `src/icons` and import it in `src/components/Home/Home.js`.
4. Add component for the button into `src/components/Home/Home.js`.
5. Add environment variable config into `src/config.js`
6. Add the environment with an example value in `docker-compose.yml`
Afterwards, build the container via docker (see above) and check if the button is displayed correctly.