-
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
202732b
commit 1287414
Showing
1 changed file
with
91 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> | ||
|
||
[]() | ||
[](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 | ||
|
||
[](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/> | ||
|
||
[](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. |
1287414
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs: