Welcome to the GDSC FSC URL Shortener project! This web application is designed to help users manage and share URLs efficiently.
- 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.
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
To get started with the project, follow these steps:
-
Clone the repository:
git clone https://github.com/GDSC-FSC/gdsc-farmingdale-links.git cd gdsc-farmingdale-links -
Install dependencies: Ensure you have Node.js installed on your machine. Then run:
npm install
-
Setup environment variables: Create a
.envfile in the root directory and add the necessary Firebase configuration settings. -
Run the development server: After installing the dependencies and setting up the environment variables, start the development server with:
npm start
Once the server is running, you can access the application by going to http://localhost:3000 in your web browser.
- 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.
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.
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!