Skip to content
This repository has been archived by the owner on Feb 4, 2023. It is now read-only.

Latest commit

 

History

History
219 lines (164 loc) · 7.96 KB

README.md

File metadata and controls

219 lines (164 loc) · 7.96 KB

Linkify - All your Links in one

Note

The project is on hold at present.
Major or very minor changes are not accepted for the Hacktoberfest event.
Documentation changes, code/website changes, etc., are included in the Hacktoberfest event.

Maintenance Open Source Love svg1 contributions welcome issues

Linkify Banner

Welcome to Design & Code where anyone interested in designing and coding can connect and interact with fellow peers from all over the globe and not only learn but also collaborate on various projects!



Join our Community and feel free to drop your questions on

Discord


What is Linkify?

A site that lets you include all your links in a single-page website with easy customizations. It gives you your own URL to share with anyone you want on the internet.

Highlights

  • Easily Customize the looks of your webpage based on your preference.
  • Dashboard Interface with good UI.
  • Have your own custom URL to your page.
  • Open-sourced and completely free. Community can keep adding new features and customize it since it's open-sourced.

Why this project?

  • Everyone needs a website to quickly share which can have all their links together. This is why an open-sourced project can have more customizations and will be completely free.
  • Good project for the community to build as well as use it for themselves. Since making a project which is not much useful for the community is useless.
  • Most of the other platforms have very limited customization and have paid features.

Tech Stack used

Skill Skill JavaScript React NodeJS NPM Firebase Netlify

Folder Structure 📁

root
├── public
│   ├── favicon.io
│   ├── index.html
│   ├── manifest.json
│   └── robots.txt
│
├── src
│   ├── components
│   │   ├── assets
│   │   │   └── asset files
│   │   │
│   │   ├── component
│   │   │   ├── component1.jsx
│   │   │   └── component2.jsx
│   │   │
│   │   └── component
│   │       ├── component1.jsx
│   │       └── component2.jsx
│   │
│   ├── pages
│   │   ├── page
│   │   │   └── index.jsx
│   │   │
│   │   └── page
│   │       └── index.js
│   │
│   ├── index.js
│   ├── App.js
│   ├── App.css
│   └── context.js
│
├──  .gitignore
├──  CONTRIBUTING.md
├──  README.md
├──  package-lock.json
└──  package.json

Design

Frame 11

Contribution Guidelines 🏗

Want to add your inputs to the repo? We invite you to contribute. To start contributing, follow the below guidelines:

1. Fork this repository.

2. Clone your forked copy of the project.

git clone https://github.com/<your_user_name>/Linkify.git

3. Navigate to the project directory 📁 .

cd Linkify

4. Add a reference (remote) to the original repository.

git remote add upstream https://github.com/Design-and-Code/Linkify.git

5. Check the remotes for this repository.

git remote -v

6. Always take a pull from the upstream repository to your master branch to keep it at par with the main project (updated repository).

git pull upstream main

7. Create a new branch.

git checkout -b <your_branch_name>

8. Perfom your desired changes to the code base.

9. Track your changes ✔.

git add . 

10. Commit your changes.

git commit -m "Relevant message"

11. Push the committed changes in your feature branch to your remote repo.

git push -u origin <your_branch_name>

12. To create a pull request, click on Compare & pull requests.

13. Add appropriate title and description to your pull request explaining your changes and efforts done.

14. Click on Create pull request.

15 Voilà! You have made a PR to Linkify 💥. Wait for your submission to be accepted and your PR to be merged.

Head to CONTRIBUTING.md for more details.

Project Maintainers 🛠


Devraj Chatribin

💻

Our Valuable Contributors 👩‍💻👨‍💻