Scissors is a URL shortener project built with React, TypeScript for the frontend, and Firebase for the backend. It allows you to create short and customized URLs for easy sharing and tracking.
- Generate short URLs for long web addresses
- Customize the generated URL with a custom alias
- Track the number of clicks on each shortened URL
- View analytics and statistics for your shortened URLs
- React: A JavaScript library for building user interfaces
- TypeScript: A typed superset of JavaScript that compiles to plain JavaScript
- Firebase: A platform for building web and mobile applications
- Vercel: A cloud platform for deploying web applications
To run the Scissors URL Shortener project locally, follow these steps:
-
Clone the repository:
git clone https://github.com/your-username/scissors.git
-
Navigate to the project directory:
cd scissors
-
Install the dependencies:
npm install
-
Start the development server:
npm start
-
Open your browser and visit
http://localhost:3000
to access the application.
Before running the project, make sure to set up the Firebase backend and obtain the necessary configuration values. Update the Firebase configuration in the project accordingly. You can find the Firebase configuration file at src/firebase/config.ts
.
To deploy the Scissors URL Shortener project on Vercel, follow these steps:
-
Create a Vercel account at vercel.com.
-
Install the Vercel CLI:
npm install -g vercel
-
Build the project for production:
npm run build
-
Login to Vercel using the CLI:
vercel login
-
Deploy the project:
vercel
-
Follow the prompts in the CLI to configure and deploy the project on Vercel.
-
Once the deployment is complete, Vercel will provide you with a unique URL for your deployed project.
Contributions are welcome! If you find any issues or have suggestions for improvement, please create an issue or submit a pull request.
This project is not licensed and is also open source
- The Scissors URL Shortener project was inspired by the need for a simple and customizable URL shortening solution.
- Special thanks to the developers and contributors of React, TypeScript, Firebase, and Vercel for their amazing tools and platforms.
For any inquiries or questions, feel free to contact us at dansiecrown@gmail.com.