Skip to content

Commit cdc7cb0

Browse files
Merge pull request #14 from Deviprakash9908/main
Changes and a Feature
2 parents d8bd9c5 + a366b93 commit cdc7cb0

7 files changed

+14063
-2544
lines changed

README.md

+20-27
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MyLinx
2-
## _A simple bio links tool for ***developers***_
32

3+
## _A simple bio links tool for ***developers***_
44

55
![Travis (.com)](https://img.shields.io/travis/com/youaskwebuild/MyLinx?style=for-the-badge)
66
![Maintenance](https://img.shields.io/maintenance/yes/2021?style=for-the-badge)
@@ -17,21 +17,18 @@
1717
![Website](https://img.shields.io/website?down_message=Offline&style=for-the-badge&up_message=Online&url=https%3A%2F%2Fyouaskwebuild.github.io%2FMyLinx%2F)
1818
![Discord](https://img.shields.io/discord/854067244274155540?style=for-the-badge)
1919

20+
MyLinx is an open source tool to create and host your bio links page in github.
2021

21-
22-
23-
MyLinx is an open source tool to create and host your bio links page in github.
24-
25-
Looking for a demo ?
22+
Looking for a demo ?
2623

2724
[MyLinx Demo](https://youaskwebuild.github.io/MyLinx/)
2825

29-
[MyLinx Builder Demo](https://youaskwebuild.github.io/MyLinx/builder.html)
26+
[MyLinx Builder Demo](https://deviprakash9908.github.io/MyLinx/builder.html)
3027

3128
## Features
3229

3330
- Add unlimited links
34-
- Search and filter
31+
- Search and filter
3532
- Add Social media links
3633
- Customize your background
3734
- Highlight links
@@ -46,20 +43,20 @@ MyLinx uses the following open source projects:
4643

4744
And of course [MyLinx](https://github.com/YouAskWeBuild/MyLinx) itself is open source with a Apache 2.0 license on GitHub.
4845

49-
50-
## Do you need one like the Demo for yourself ?
46+
## Do you need one like the Demo for yourself ?
5147

5248
Here is what you should do
5349

5450
- Fork the repository [MyLinx](https://github.com/youaskwebuild/MyLinx/fork)
5551
- Go to Settings -> Pages -> Select **gh-pages** branch, **/root** in the next select folder and click on **Save**
5652

57-
![Example](./how-to-use.png)
53+
![Example](./how-to-use.png)
54+
5855
- Your own site ([your-github-profile-name].github.io/MyLinx) will be up soon.
5956

6057
- You can either visit ([your-github-profile-name].github.io/MyLinx/builder.html) or visit [MyLinx Builder](https://youaskwebuild.github.io/MyLinx/builder.html) to add your own links to display on Mylinx.
6158

62-
- Once you are done, click on **Copy Data** button on the builder page. This will copy the links data to clipboard.
59+
- Once you are done, click on **Copy Data** button on the builder page. This will copy the links data to clipboard.
6360

6461
- Now go to your repository and switch your branch to gh-pages
6562

@@ -69,9 +66,6 @@ Here is what you should do
6966

7067
- In case you want to add or remove, you can click on **Load Data** button and paste the content of your data.json and begin editing from there.
7168

72-
73-
74-
7569
## Installation
7670

7771
### To run locally
@@ -85,49 +79,48 @@ Install the dependencies and devDependencies and start the server.
8579
```sh
8680
cd MyLinx
8781
npm install
88-
npm run start
82+
npm run start:api
83+
npm run start:client
8984
```
9085

9186
For production environments...
9287

9388
```sh
94-
npm install
89+
npm install
9590
npm run build
9691
```
9792

9893
## Plugins
9994

10095
MyLinx is currently extended with the following plugins.
10196

102-
| Plugin | Usage |
103-
| ------ | ------ |
104-
|Tailwind Forms | Forms in MyLinx builder are built using tailwind forms plugin
97+
| Plugin | Usage |
98+
| -------------- | ------------------------------------------------------------- |
99+
| Tailwind Forms | Forms in MyLinx builder are built using tailwind forms plugin |
105100

106101
## Contribute
107102

108103
Want to contribute? Great!
109104

110105
[Join our discord server](https://discord.gg/m7GhgH6cdt)
111106

112-
Let us know what feature you want to work on, then proceed.
107+
Let us know what feature you want to work on, then proceed.
113108

114109
Fork the repository [MyLinx](https://github.com/youaskwebuild/MyLinx/fork)
115110

116111
Clone your forked repository
117-
118-
Make the changes to your clone and provide a PR!
119112

113+
Make the changes to your clone and provide a PR!
120114

121115
## License
122116

123117
Apache 2.0
124118

125119
**Free Software, Hell Yeah!**
126120

127-
128-
[TailwindCSS]: <https://github.com/tailwindlabs/tailwindcss>
129-
[Tailwind Forms]: <https://github.com/tailwindlabs/tailwindcss-forms>
130-
121+
[tailwindcss](https://github.com/tailwindlabs/tailwindcss)
122+
[tailwind forms](https://github.com/tailwindlabs/tailwindcss-forms)
123+
[sortable.js](http://sortablejs.github.io/Sortable/)
131124

132125
## Authors
133126

0 commit comments

Comments
 (0)