mirror of
https://github.com/johnggli/linktree.git
synced 2026-08-16 22:46:04 +01:00
67 lines
2.8 KiB
Markdown
67 lines
2.8 KiB
Markdown
<h1 align="center">🌲 Linktree</h1>
|
|
<h3 align="center">Simple site to group all my profiles on social networks in one place.</h3>
|
|
|
|
<p align="center">
|
|
<img alt="GitHub top language" src="https://img.shields.io/github/languages/top/johnggli/linktree?color=04D361&labelColor=000000">
|
|
|
|
<a href="https://www.linkedin.com/in/johnggli/">
|
|
<img alt="Made by" src="https://img.shields.io/static/v1?label=made%20by&message=John%20Emerson&color=04D361&labelColor=000000">
|
|
</a>
|
|
|
|
<img alt="Repository size" src="https://img.shields.io/github/repo-size/johnggli/linktree?color=04D361&labelColor=000000">
|
|
|
|
<a href="https://github.com/johnggli/linktree/commits/master">
|
|
<img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/johnggli/linktree?color=04D361&labelColor=000000">
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="#-about-the-project">About the project</a> |
|
|
<a href="#-getting-started">Getting started</a> |
|
|
<a href="#-how-to-contribute">How to contribute</a> |
|
|
<a href="#-license">License</a>
|
|
</p>
|
|
|
|
---
|
|
|
|
<p align="center">
|
|
<img alt="screenshot" src="screenshot.png">
|
|
</p>
|
|
|
|
---
|
|
|
|
## 💡 About the project
|
|
|
|
This is an open source project that serves as a free alternative to the Linktree website.
|
|
- [Demo](https://johnggli.github.io/linktree)
|
|
|
|
## 🚀 Getting started
|
|
|
|
If you installed git you can clone the code to your machine, or download a ZIP of all the files directly.
|
|
[Download the ZIP from this location](https://github.com/johnggli/linktree/archive/master.zip), or run the following [git](https://git-scm.com/downloads) command to clone the files to your machine:
|
|
```bash
|
|
git clone https://github.com/johnggli/linktree
|
|
```
|
|
- Once the files are on your machine, open the _linktree_ folder in [Visual Studio Code](https://code.visualstudio.com/).
|
|
- With the files open in Visual Studio Code, press the **Go Live** button at the bottom of the window to launch the files with [Live Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer).
|
|
- Change the profile image and texts in the `index.html` file.
|
|
- Change the colors and fonts in the `style.css` file.
|
|
- To change the background, go to the `style.css` file on line 17, uncomment the code snippet and change the url to whatever image you want.
|
|
|
|
## 🤔 How to contribute
|
|
|
|
- Fork this repository;
|
|
- Create a branch with your feature: `git checkout -b my-feature`;
|
|
- Commit your changes: `git commit -m "feat: my new feature"`;
|
|
- Push to your branch: `git push origin my-feature`.
|
|
|
|
Once your pull request has been merged, you can delete your branch.
|
|
|
|
## 📝 License
|
|
|
|
This project is under the MIT license. See the [LICENSE](LICENSE.md) file for more details.
|
|
|
|
---
|
|
|
|
Made with ❤️ by John Emerson :wave: [Get in touch](https://johnggli.github.io/linktree)
|