FireShort

KO | EN

gitlite — search

#python #hacktoberfest #react #ai #typescript #llm #golang #android #machine-learning #cli #kubernetes #pytorch #openai #mcp

(★ 32)

A URL Shortener made using React.JS and Google Firestore

FireShort Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![Contributions](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)
[![GitHub license](https://img.shields.io/github/license/thedevs-network/kutt.svg)](https://github.com/monizb/FireShort/blob/master/LICENSE)
![Issues](https://img.shields.io/github/issues/monizb/FireShort)
[![All Contributors](https://img.shields.io/badge/all_contributors-9-orange.svg?style=flat-square)](https://raw.githubusercontent.com/monizb/FireShort/master/)
![Stars](https://img.shields.io/github/stars/monizb/FireShort)

Fireshort is a URL shortener made using Google Firestore and React.JS The
original repository has been forked from
[here](https://github.com/xprilion/fireshort)

The following features has been added to the original repository before pushing
this rep:

- The generated links now track the number of hits on them
- The Custom URL is an optional field now, if left black it generates a random 8
  character long code using NanoID
- Ability to track link activity : The links can now track the timestamp,ipv4
  and User-Agent of the Request source
- The Link Tracking feature for any link can be switched on/off at anytime from
  Admin Panel
- A lot of UI Changes

### Features To Be Added
The following features are under development/open for contributions.Please first
create a feature issue to discuss about the feature you would like to take up.

- [x] Multiple Admin Panels and New User Registration
- [x] Ability to check for Custom URL clashes across all users instantly to
      verify if it has been taken already
- [x] Make a page for link analytics , with number of clicks,and all the
      activity related to it
- [x] Add a lot more Analytics options with different types of charts
- [x] Show a Dialog box with the created link wth different sharing option and a
      way to show QR Codes (and a way to track every qr scan) for the same
- [x] Add a homepage showcasing the tool with animations
- [x] Revamp the dashboard
- [ ] Develop APIs for all the tasks for easy management
- [ ] Add Link Expiry
- [x] Add Password Protected Links

Valid Feature Requests will be added to the above list over time.

### Running The Project

Prerequisites For Running The Project Locally:
- Node
- NPM
- A Firebase Project
- Git

Before cloning the project make sure you have created a firebase project on
[Firebase Console](http://console.firebase.google.com)

To clone this repository run:

```sh
$ git clone https://github.com/monizb/FireShort.git
```

Head inside the cloned folder and install the dependencies using NPM

```sh
$ cd FireShort
$ npm install
```

Next create a .env file in the root of the project directory, this is where you
will put all your firebase config keys Go to Firebase console and select the
project you just created, Select Add App and select Web, follow the on-screen
instructions until Firebase provides you with a config object, take each
property of the provided object and put it inside of the .env file like this:

```
REACT_APP_API_KEY=
REACT_APP_AUTH_DOMAIN=
REACT_APP_DB_URL=
REACT_APP_PROJECT_ID=
REACT_APP_STORAGE_BUCKET=
REACT_APP_SENDER_ID=
REACT_APP_APP_ID=
REACT_APP_MEAS_ID=
```

Save the file and now in the Firebase Console Goto Authentication > SignIn
Methods > Enable Email Sigin. This now enables you to create a new account using
Email And Password in the app. Next, Goto Cloud Firestore > Create Database and
then navigate to the rules tab and copy paste the rules from
[here](https://github.com/monizb/FireShort/blob/master/firestore.rules)

For the final step run:

```sh
$ npm start
```

Wait for a few minutes after which it should automatically spin up a development
server for you on the PORT:3000 and take you to the login page

### Contributing

To contribute to this repository please first create an issue with the
appropriate template, after which you can directly fork this repository,make
changes and start a pull request to the master branch. Please also have a look
at our Contribution guidelines
[here](https://github.com/monizb/FireShort/blob/master/CONTRIBUTING.md)

### Live Demo

https://fbls.ml

### License

MIT Licensed (Check
[here](https://github.com/monizb/FireShort/blob/master/LICENSE))

## Contributors ✨

Thanks goes to these wonderful people
([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<table>
 <tr>
 <td align="center"><a href="https://alii13.github.io/portfolio/"><img src="https://avatars1.githubusercontent.com/u/48530814?v=4" width="50px;" alt=""/> Shekh Aliul</a> <a href="#a11y-alii13" title="Accessibility">️️️️♿️</a></td>
 <td align="center"><a href="https://github.com/OverthinkersArea"><img src="https://avatars2.githubusercontent.com/u/53104897?v=4" width="50px;" alt=""/> 0ver3inker</a> <a href="https://github.com/monizb/FireShort/commits?author=OverthinkersArea" title="Documentation">📖</a></td>
 <td align="center"><a href="http://harshvats.vercel.app"><img src="https://avatars0.githubusercontent.com/u/45518343?v=4" width="50px;" alt=""/> HARSH VATS</a> <a href="https://github.com/monizb/FireShort/commits?author=harshvats2000" title="Code">💻</a></td>
 <td align="center"><a href="https://github.com/asi309"><img src="https://avatars0.githubusercontent.com/u/22616656?v=4" width="50px;" alt=""/> Asidipta</a> <a href="https://github.com/monizb/FireShort/commits?author=asi309" title="Code">💻</a></td>
 <td align="center"><a href="https://github.com/vikashgaya916"><img src="https://avatars1.githubusercontent.com/u/62158550?v=4" width="50px;" alt=""/> Vikash Kumar</a> <a href="https://github.com/monizb/FireShort/issues?q=author%3Avikashgaya916" title="Bug reports">🐛</a> <a href="#design-vikashgaya916" title="Design">🎨</a></td>
 <td align="center"><a href="http://aryanverma.in"><img src="https://avatars1.githubusercontent.com/u/12378189?v=4" width="50px;" alt=""/> Aryan Verma</a> <a href="https://github.com/monizb/FireShort/commits?author=i-aryan" title="Code">💻</a></td>
 <td align="center"><a href="https://github.com/TaarnStar"><img src="https://avatars3.githubusercontent.com/u/17704741?v=4" width="50px;" alt=""/> Marko Milošević</a> <a href="https://github.com/monizb/FireShort/issues?q=author%3ATaarnStar" title="Bug reports">🐛</a></td>
 </tr>
 <tr>
 <td align="center"><a href="https://github.com/rahul1995"><img src="https://avatars0.githubusercontent.com/u/7647789?v=4" width="50px;" alt=""/> rahul1995</a> <a href="https://github.com/monizb/FireShort/commits?author=rahul1995" title="Code">💻</a></td>
 <td align="center"><a href="https://me.avitechlab.com"><img src="https://avatars1.githubusercontent.com/u/15830206?v=4" width="50px;" alt=""/> Abhinav Kumar</a> <a href="https://github.com/monizb/FireShort/commits?author=abhinavkrin" title="Code">💻</a> <a href="https://github.com/monizb/FireShort/issues?q=author%3Aabhinavkrin" title="Bug reports">🐛</a></td>
 <td align="center"><a href="https://github.com/pyplacca"><img src="https://avatars3.githubusercontent.com/u/36242450?v=4" width="50px;" alt=""/> David Placca</a> <a href="https://github.com/monizb/FireShort/commits?author=pyplacca" title="Code">💻</a></td>
 <td align="center"><a href="https://willianrod.com/"><img src="https://avatars1.githubusercontent.com/u/6539258?v=4" width="50px;" alt=""/> Willian Rodrigues</a> <a href="https://github.com/monizb/FireShort/commits?author=WillianRod" title="Code">💻</a> <a href="#design-WillianRod" title="Design">🎨</a></td>
 </tr>
</table>

This project follows the
[all-contributors](https://github.com/all-contributors/all-contributors)
specification. Contributions of any kind welcome!

FireShort

FireShort Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

FireShort

FireShort Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README