Skip to content

linkashare/linkashare-ui

Repository files navigation

Contributors Forks Stargazers Issues MIT License


Logo

LinkAShare

Project Description
View on Github »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Acknowledgments

About The Project

Product Name Screen Shot

Edit the README.md to get started.

(back to top)

Built With

  • React

(back to top)

Getting Started

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

Prerequisites

  • npm
    npm install npm@latest -g

Installation

  1. Clone the repo
    git clone https://github.com/_your-username/linkashare-ui.git
  2. Install NPM packages
    yarn install
  3. Run The Project
    yarn run dev
  4. Build the project
    yarn run build

(back to top)

Roadmap

  • Add README
  • Add back to top links
  • Added the navbar
  • Change Licence to MIT
  • Add Linting Support
  • Create 404 Page
  • Create SignUp
  • Create Login
  • Create Homepage
  • Shorten Link on Homepage

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the Apache License. See LICENSE.txt for more information.

(back to top)

Acknowledgments

These are list of resources that we find helpful and would like to give credit to.

(back to top)