/TeleSpace

Primary LanguageJavaScriptMIT LicenseMIT

Frontend for Telespace 🚀

Introduction

This repository contains the frontend code for Telespace, a platform that utilizes Telegram for unlimited data storage. The frontend is built using modern web technologies including React, TypeScript, and Vite.

Table of Contents

Features

  • Fast and Simple
  • Responsive user interface for data management
  • Integration with backend services for real-time data synchronization
  • Offline capabilities with service workers

Installation

To get started with this project, clone the repository and install the dependencies:

git clone https://github.com/FireWtap/TeleSpace
cd TeleSpace
npm install

Usage

To run the frontend in development mode, use the following command:

Please remember to set all the config files with the required credentials for it to work. (Firebase cloud notification in particular)

npm run dev

This will start the Vite server and open the application in your default web browser.

Project Structure

  • src/: Contains all the source code of the application.
    • components/: Reusable UI components.
    • pages/: Application pages.
    • utils/: Utilities and helper functions.
    • assets/: Static assets like images and icons.
    • stores/: State management using stores.

Dependencies

  • React: A JavaScript library for building user interfaces.
  • Vite: A build tool that aims to provide a faster and leaner development experience for modern web projects.
  • TypeScript: A typed superset of JavaScript that compiles to plain JavaScript.

Scripts

  • npm run dev: Run the development server.
  • npm build: Build the application for production.

Contributing

Contributions to the project are welcome! Please fork the repository and submit a pull request with your changes. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.