https://github.com/womb0comb0/gdsc-farmingdale-url-shortener
GDSC FSC | Url - Your go-to link shortener for staying updated on GDSC FSC's latest events and domains. Easily manage and share URLs with this convenient web application.
https://github.com/womb0comb0/gdsc-farmingdale-url-shortener
css firebase gcp html pwa react tailwindcss typescript vitejs
Last synced: 3 months ago
JSON representation
GDSC FSC | Url - Your go-to link shortener for staying updated on GDSC FSC's latest events and domains. Easily manage and share URLs with this convenient web application.
- Host: GitHub
- URL: https://github.com/womb0comb0/gdsc-farmingdale-url-shortener
- Owner: WomB0ComB0
- Created: 2024-02-23T22:32:49.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-10T02:41:38.000Z (4 months ago)
- Last Synced: 2025-02-10T03:26:22.559Z (4 months ago)
- Topics: css, firebase, gcp, html, pwa, react, tailwindcss, typescript, vitejs
- Language: TypeScript
- Homepage: https://gdsc-fsc-url.web.app
- Size: 2.22 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GDSC FSC | URL Shortener
Welcome to the GDSC FSC URL Shortener project! This web application is designed to help users manage and share URLs efficiently.
## Table of Contents
- [Features](#features)
- [Technologies](#technologies)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Features
- User-friendly interface for shortening URLs.
- Supports multiple platforms (iOS, Android, Windows).
- Progressive Web App (PWA) capabilities.
- Open Graph and Twitter card integration for enhanced sharing.
- Cookie consent management for user privacy.
## Technologies
This project is built using the following technologies:
- **Frontend**: React, Tailwind CSS
- **Backend**: Firebase
- **Utilities**: Workbox for service workers, and various Radix UI components
- **Deployment**: Vercel or Firebase Hosting
## Installation
To get started with the project, follow these steps:
1. **Clone the repository**:
```bash
git clone https://github.com/GDSC-FSC/gdsc-farmingdale-links.git
cd gdsc-farmingdale-links
```
2. **Install dependencies**:
Ensure you have Node.js installed on your machine. Then run:
```bash
npm install
```
3. **Setup environment variables**:
Create a `.env` file in the root directory and add the necessary Firebase configuration settings.
4. **Run the development server**:
After installing the dependencies and setting up the environment variables, start the development server with:
```bash
npm start
```
## Usage
Once the server is running, you can access the application by going to `http://localhost:3000` in your web browser.
### Key Features to Explore:
- **URL Shortening**: Paste any URL and click the button to shorten it.
- **Management Interface**: View and manage your shortened URLs.
- **PWA Functionality**: Install the app on your device for offline access.
## Contributing
We welcome contributions! If you would like to contribute to the project, please fork the repository and create a pull request. Ensure to follow the code of conduct and adhere to the coding standards.
## License
This project is licensed under the MIT License. See the LICENSE file for more information.
---
Feel free to reach out if you have any questions or suggestions! Happy coding!