Skip to content

Latest commit

 

History

History
68 lines (51 loc) · 3.69 KB

README.md

File metadata and controls

68 lines (51 loc) · 3.69 KB

Link Ship - A ship with links 🚢

Simple site to group all of your profiles on social networks in one place. ❤️

Documentation

About This Project

image

Linkship allows you to create a personal profile page. Many social media platforms only allow for one link. With this, you can have all the links you want clickable on one site. Set up your personal site on your own server in a few clicks.

NodeJS Version Issues Forks Stars LICENSE Contributors Repository Size

Codacy Badge

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

In order to get a copy of the project you will require you to have Node.js (v14+) and the NPM package manager installed. If you don't have it, you can download the latest version of Node.js from the official website which also installs the NPM package manager by default.

Installation

Open the terminal in the folder in which you wish to clone the repository and enter the following command:

git clone https://github.com/Dojeto/LinkShip-Frontend.git .

Install all the NPM packages:

npm i

In order to run the server:

npm run dev

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/YourAmazingFeature)
  3. Commit your Changes (git commit -m 'Add some YourAmazingFeature')
  4. Push to the Branch (git push origin feature/YourAmazingFeature)
  5. Open a Pull Request

⚫Contributors

Dojeto

Alt