Fireshort is a URL shortener made using Google Firestore and React.JS The original repository has been forked from here
The following features has been added to the original repository before pushing this rep:
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.
Valid Feature Requests will be added to the above list over time.
Prerequisites For Running The Project Locally:
Before cloning the project make sure you have created a firebase project on Firebase Console
To clone this repository run:
$ git clone https://github.com/monizb/FireShort.git
Head inside the cloned folder and install the dependencies using NPM
$ 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
For the final step run:
$ 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
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
MIT Licensed (Check here)
Thanks goes to these wonderful people (emoji key):
Shekh Aliul ️️️️♿️ |
0ver3inker 📖 |
HARSH VATS 💻 |
Asidipta 💻 |
Vikash Kumar 🐛 🎨 |
Aryan Verma 💻 |
Marko Milošević 🐛 |
rahul1995 💻 |
Abhinav Kumar 💻 🐛 |
David Placca 💻 |
Willian Rodrigues 💻 🎨 |
This project follows the all-contributors specification. Contributions of any kind welcome!