Skip to content

Commit

Permalink
update readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
uiuxarghya committed Apr 30, 2021
1 parent 202732b commit 1287414
Showing 1 changed file with 91 additions and 2 deletions.
93 changes: 91 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,91 @@
# 8bits Link Shortner
A simple link shortner
# **8bits Link Shortner**

<div align="center">
<img src="./docs/banner.svg" align="center">
<br/>
<br/>
<p>
<b><h2>8bits LInk Shortener - A simple serverless url shortener.</h2></b>
</p>
<p>
<i>Helps you shorten long links for easy sharing.
</p>
<p>

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/uiuxarghya/8bits)]()
[![Website](https://img.shields.io/website?url=https%3A%2F%2F8bits.vercel.app&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA0AAAAZCAYAAADqrKTxAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAADDSURBVHgB7ZRNDoIwEIXflHoPiInXEE+iJsbEW+gpiLgQT0K8Bv7APaCtpQV34wKjK96ieWnfl0wyMyX0KtIVAjqDkzJrzLZZawUGiHBLYm9FDBJzNqnNBaSq1koImXd8hulmwUL3YwaSy8HljdA3kO1TEzlXBzEeackmFQ6YNHsPRbvKXRapPShkIRj0WYky8cHaPVT4pC4roaUvKXBjFLFAO0Zaui0Ym/t3yPYJfsWNDvE85WxS6asdCpel9+Wvv7AXkbg7KN08dlIAAAAASUVORK5CYII=)](https://8bits.vercel.app)

<p>
<sub>Built with ❤︎ by
<a href="https://github.com/uiuxarghya">uiuxarghya</a>
</sub>
</p>

</div>

<div align="center">
<a href="https://8bits.vercel.app/"><img src="./docs/demo.svg" alt="Screenshot" width="100%"></a>
</div>

<br/>
<div>

## **About**

### A simple serverless url shortener made with [Mongo DB](https://mongodb.com) and [Vercel](https://vercel.com).

</div>


## **Demo**

[8bits.vercel.app](https://8bits.vercel.app)


## [**Documentation**](https://github.com/uiuxarghya/8bits/wiki)
Check the detailed documentation at our [wiki](https://github.com/uiuxarghya/8bits/wiki) page.

## **Features**

❤️ **Lightweight:** Crafted with minimalistic UI design.

⚡️ **Fast:** Paste long url and get/copy short url in less than a second.


## **Developing**

1. Create a `.env.local` file repository's root directory with your own keys.


_Sample keys only works with the [production build](https://8bits.vercel.app)._

### Browser based development environment

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/uiuxarghya/8bits)

### Local development environment

1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) with git.
2. Install dependencies by running `npm install` within the directory that you cloned (probably `8bits`).
3. Start the development server with `npm run dev`.
4. Open development site by going to [`http://localhost:3000`](http://localhost:3000) in your browser.

## **Deploy now with Vercel**
<p/>

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js%2Ftree%2Fcanary%2Fexamples%2Fhello-world&env=VERCEL_URL,MONGODB_URI&project-name=8bits&demo-title=8bits&demo-description=A%20simple%20serverless%20url%20shortener%20made%20with%20MongoDB%20and%20Vercel.&demo-url=https%3A%2F%2F8bits.vercel.app%2F)


## **Changelog**

See the [`CHANGELOG`](CHANGELOG.md) file for details.

## **Authors**

### Lead Developers

- **[Arghya Ghosh](https://github.com/uiuxarghya)** - _Author_

## **License**

This project is licensed under the [MIT License](https://opensource.org/licenses/MIT) - see the [`LICENSE`](LICENSE) file for details.

1 comment on commit 1287414

@vercel
Copy link

@vercel vercel bot commented on 1287414 Apr 30, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.