Skip to content

πŸ“Š Reports Mini App - A Telegram Mini App integrated with Google Sheets & Apps Script. (Interface lang: UZ)

Notifications You must be signed in to change notification settings

yaxyobekuz/reports-mini-app

Repository files navigation

πŸ“Š Reports Mini App

This project is built with React, Vite, and TailwindCSS to deliver a fast and responsive web application with a streamlined development experience.

Project Preview


πŸš€ Live Demo

πŸ”— View Live

πŸ“Œ Features

  • Vite: A fast development build tool with Hot Module Replacement (HMR).
  • React: A JavaScript library for building dynamic user interfaces.
  • TailwindCSS: A utility-first CSS framework that provides pre-configured styling for rapid UI development.
  • Hot Module Replacement (HMR): Enables instant updates without full page reload during development.
  • ESLint: Configured for linting JavaScript/JSX files for code quality.

πŸ”₯ Getting Started

Prerequisites

  • Node.js (version 14.x or higher)
  • npm (version 6.x or higher) or Yarn (optional)

πŸ“₯ Installation

1️⃣ Clone the repository:

git clone https://github.com/yaxyobekuz/reports-mini-app.git
cd reports-mini-app

2️⃣ Install dependencies:

npm install
# or
yarn install

Development Server

To start the development server with HMR:

npm run dev
# or
yarn dev

The app will be available at http://localhost:5173 by default.

Build for Production

To create a production build of your app:

npm run build
# or
yarn build

The production-ready files will be in the dist/ directory.

Preview Production Build

To preview the production build locally:

npm run preview
# or
yarn preview

Linting

To lint your files:

npm run lint
# or
yarn lint

Dotenv (.env file)

VITE_API_BASE_URL=YOUR_APPS_SCRIPT_URL
VITE_SECRET_KEY=YOUR_SECRET_KEY

πŸ“‚ Project Structure

β”œβ”€β”€ public/              # Public assets (favicon, etc.)
β”œβ”€β”€ src/                 # Source files
β”‚   β”œβ”€β”€ assets/          # Static assets (images, icons, etc.)
β”‚   β”œβ”€β”€ components/      # Reusable React components
β”‚   β”œβ”€β”€ pages/           # Page components
β”‚   β”œβ”€β”€ layouts/         # Layout components
β”‚   β”œβ”€β”€ index.css        # Tailwind CSS configuration and global styles
β”‚   β”œβ”€β”€ App.jsx          # Main app component
β”‚   β”œβ”€β”€ main.jsx         # Entry point for the app
β”‚   └── ...              # Others...
β”œβ”€β”€ postcss.config.js    # PostCSS configuration
β”œβ”€β”€ tailwind.config.js   # TailwindCSS configuration
β”œβ”€β”€ vite.config.js       # Vite configuration
β”œβ”€β”€ index.html           # Main HTML file
└── package.json         # Project metadata and dependencies

πŸ’¨ Customizing TailwindCSS

TailwindCSS is already configured, but you can modify the tailwind.config.js file to extend or customize the theme, such as adding new colors, fonts, or spacing values.

Example:

module.exports = {
  theme: {
    extend: {
      colors: {
        primary: "#A6B9FF",
        // ... More colors
      },
    },
  },
};

πŸƒ Scripts

  • dev: Starts the development server with HMR.
  • build: Builds the application for production.
  • preview: Previews the production build.
  • lint: Lints your code with ESLint.

πŸ›  Technologies Used

  • React: A JavaScript library for building user interfaces.
  • Vite: A modern front-end build tool for blazing-fast development.
  • TailwindCSS: Utility-first CSS for styling and layout.
  • PostCSS: CSS tool for transforming styles with plugins like TailwindCSS.
  • ESLint: A tool for identifying and fixing problems in JavaScript code.

πŸ” Learn More


πŸ“ž Contact

If you have any questions or feedback, feel free to reach out:
πŸ“§ Email: pubgn9642@gmail.com
πŸ”— Website: yaxyobekk.uz

About

πŸ“Š Reports Mini App - A Telegram Mini App integrated with Google Sheets & Apps Script. (Interface lang: UZ)

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published