Files
linktree/README.md

65 lines
2.8 KiB
Markdown
Raw Normal View History

2021-11-26 15:55:38 -03:00
<h1 align="center">🌲 Linktree</h1>
2020-06-22 20:38:15 -03:00
<h3 align="center">Simple site to group all my profiles on social networks in one place.</h3>
2020-03-22 13:36:02 -03:00
<p align="center">
2022-04-29 16:35:23 -03:00
<img alt="GitHub top language" src="https://img.shields.io/github/languages/top/jchn146/linktree?color=04D361&labelColor=000000">
2020-08-18 19:23:16 -03:00
2022-04-29 16:35:23 -03:00
<a href="https://www.linkedin.com/in/jchn146/">
2021-11-11 20:20:31 -03:00
<img alt="Made by" src="https://img.shields.io/static/v1?label=made%20by&message=John%20Emerson&color=04D361&labelColor=000000">
2020-06-22 20:38:15 -03:00
</a>
2020-03-22 13:36:02 -03:00
2022-04-29 16:35:23 -03:00
<img alt="Repository size" src="https://img.shields.io/github/repo-size/jchn146/linktree?color=04D361&labelColor=000000">
2020-03-22 13:36:02 -03:00
2022-04-29 16:35:23 -03:00
<a href="https://github.com/jchn146/linktree/commits/master">
<img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/jchn146/linktree?color=04D361&labelColor=000000">
2020-03-22 13:36:02 -03:00
</a>
</p>
<p align="center">
2021-11-26 15:55:38 -03:00
<a href="#-about-the-project">About the project</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
<a href="#-getting-started">Getting started</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
<a href="#-how-to-contribute">How to contribute</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
<a href="#-license">License</a>
2020-03-22 13:36:02 -03:00
</p>
2020-08-18 19:23:16 -03:00
---
2022-04-29 16:49:00 -03:00
![preview](preview.png)
2020-08-18 19:30:04 -03:00
---
2021-11-26 15:55:38 -03:00
## 💡 About the project
2020-08-18 19:23:16 -03:00
2021-11-11 20:20:31 -03:00
This is an open source project that serves as a free alternative to the Linktree website.
2022-04-29 16:35:23 -03:00
- [Demo](https://jchn146.github.io/linktree)
2020-08-18 19:23:16 -03:00
2021-11-26 15:55:38 -03:00
## 🚀 Getting started
2020-08-18 19:23:16 -03:00
2021-11-26 15:55:38 -03:00
If you installed git you can clone the code to your machine, or download a ZIP of all the files directly.
2022-04-29 16:35:23 -03:00
[Download the ZIP from this location](https://github.com/jchn146/linktree/archive/master.zip), or run the following [git](https://git-scm.com/downloads) command to clone the files to your machine:
2021-11-26 15:55:38 -03:00
```bash
2022-04-29 16:35:23 -03:00
git clone https://github.com/jchn146/linktree
2021-11-26 15:55:38 -03:00
```
- 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).
2021-11-22 14:49:01 -03:00
- Change the profile image and texts in the `index.html` file.
2021-11-11 20:20:31 -03:00
- Change the colors and fonts in the `style.css` file.
2021-11-22 14:49:01 -03:00
- 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.
2020-08-18 19:23:16 -03:00
2021-11-26 15:55:38 -03:00
## 🤔 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
2020-03-22 13:36:02 -03:00
2021-11-26 15:55:38 -03:00
This project is under the MIT license. See the [LICENSE](LICENSE.md) file for more details.
2020-03-29 23:06:18 -03:00
---
2022-04-29 16:35:23 -03:00
Made with ❤️ by John Emerson :wave: [Get in touch](https://jchn146.github.io/linktree)