Merge pull request #78 from erayerdin/dev

Sync master

README.md

@@ -1,4 +1,4 @@
-<p align="center"><img src="assets/brand/logo.svg" width="256" /></p>
+<p align="center"><img src="assets/brand/logo.gif" width="256" /></p>
 
 <h1 align="center">Firereact</h1>
 
@@ -31,10 +31,19 @@
 
 <p align="center">Firereact is hooks, component and utilities library for Firebase and React.</p>
 
+## Installation
+
+You can install the package via NPM:
+
+```bash
+npm i firereact
+```
+
 ## Features
 
  - Very lightweight, ![unpacked size](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fregistry.npmjs.org%2Ffirereact%2Flatest&query=%24.dist.unpackedSize&suffix=%20bytes&style=flat-square&label=%20)
  when unpacked, ![npm min bundle size](https://img.shields.io/bundlephobia/min/firereact?style=flat-square&label=%20) when minified, ![npm minzip bundle size](https://img.shields.io/bundlephobia/minzip/firereact?style=flat-square&label=%20) when minified+gzipped
+ - Supports ![Javascript](https://img.shields.io/badge/__-javascript-f7df1e?style=flat-square&logo=javascript&logoColor=white) and ![Typescript](https://img.shields.io/badge/__-typescript-3178c6?style=flat-square&logo=javascript&logoColor=white)
  - Supports Auth, Firestore, Functions, Providers and Storage.
  - Provides hooks such as `useUser` for Auth or `useDocument` for Firestore, which can listen to realtime changes as well
  - Provides custom components such as `<FirestoreDocument />` or `<StorageDownloadLink />` to keep the logic simple and/or avoid unnecessary rerendering

docs/index.md

@@ -1,7 +1,7 @@
 # Introduction
 
 <center>
-<img src="assets/brand/logo.svg" width="256" alt="firereact logo" />
+<img src="assets/brand/logo.gif" width="256" alt="firereact logo" />
 </center>
 
 <h1 align="center">Firereact</h1>
@@ -49,6 +49,7 @@
 ## Features
 
  - Very lightweight, ![unpacked size](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fregistry.npmjs.org%2Ffirereact%2Flatest&query=%24.dist.unpackedSize&suffix=%20bytes&style=flat-square&label=%20)
+ - Supports ![Javascript](https://img.shields.io/badge/__-javascript-f7df1e?style=flat-square&logo=javascript&logoColor=white) and ![Typescript](https://img.shields.io/badge/__-typescript-3178c6?style=flat-square&logo=javascript&logoColor=white)
  when unpacked, ![npm min bundle size](https://img.shields.io/bundlephobia/min/firereact?style=flat-square&label=%20) when minified, ![npm minzip bundle size](https://img.shields.io/bundlephobia/minzip/firereact?style=flat-square&label=%20) when minified+gzipped
  - Supports Auth, Firestore, Functions, Providers and Storage.
  - Provides hooks such as `useUser` for Auth or `useDocument` for Firestore, which can listen to realtime changes as well

package.json

@@ -19,11 +19,13 @@
     "test": "vitest run",
     "test:coverage": "vitest run --coverage",
     "format": "prettier --write --parser typescript '**/*.{ts,tsx}'",
-    "lint": "eslint . --ext .ts,.tsx --ignore-path .gitignore --fix",
-    "lint:check": "eslint . --ext .ts,.tsx --ignore-path .gitignore",
+    "lint": "eslint src --ext .ts,.tsx --ignore-path .gitignore --fix",
+    "lint:check": "eslint src --ext .ts,.tsx --ignore-path .gitignore",
     "formatter:run": "prettier --no-error-on-unmatched-pattern --write src/**/*.ts src/**/*.tsx *.ts *.tsx",
     "formatter:check": "prettier --no-error-on-unmatched-pattern --check src/**/*.ts src/**/*.tsx *.ts *.tsx",
-    "build": "tsc --project tsconfig.build.json && vite build"
+    "build": "tsc --project tsconfig.build.json && vite build",
+    "remotion:logo:start": "cd remotion/logo && npm start",
+    "remotion:logo:build": "cd remotion/logo && npm run build:gif"
   },
   "repository": {
     "type": "git",

remotion/logo/.eslintrc

@@ -0,0 +1,6 @@
+{
+	"extends": "@remotion",
+	"env": {
+		"node": true
+	}
+}

remotion/logo/.gitignore

@@ -0,0 +1,7 @@
+node_modules
+dist
+.DS_Store
+.env
+
+# Ignore the output video from Git but not videos you import into src/.
+out

remotion/logo/.prettierrc

@@ -0,0 +1,14 @@
+{
+  "singleQuote": true,
+  "bracketSpacing": false,
+  "jsxBracketSameLine": false,
+  "useTabs": true,
+  "overrides": [
+    {
+      "files": ["*.yml"],
+      "options": {
+        "singleQuote": false
+      }
+    }
+  ]
+}

remotion/logo/README.md

@@ -0,0 +1,60 @@
+# Remotion video with Tailwind
+
+<p align="center">
+  <a href="https://github.com/remotion-dev/logo">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://github.com/remotion-dev/logo/raw/main/animated-logo-banner-dark.gif">
+      <img alt="Animated Remotion Logo" src="https://github.com/remotion-dev/logo/raw/main/animated-logo-banner-light.gif">
+    </picture>
+  </a>
+</p>
+
+Welcome to your Remotion project!
+
+## Commands
+
+**Install Dependencies**
+
+```console
+npm i
+```
+
+**Start Preview**
+
+```console
+npm start
+```
+
+**Render video**
+
+```console
+npm run build
+```
+
+**Upgrade Remotion**
+
+```console
+npm run upgrade
+```
+
+## Using server-side rendering
+
+This template uses a [custom Webpack override](https://www.remotion.dev/docs/webpack). If you are using server-side rendering, you need to import the override function from `./src/webpack-override.ts` and pass it to [`bundle()`](https://www.remotion.dev/docs/bundle) (if using SSR) and [`deploySite()`](https://www.remotion.dev/docs/lambda/deploysite) (if using Lambda).
+
+## Docs
+
+Get started with Remotion by reading the [fundamentals page](https://www.remotion.dev/docs/the-fundamentals).
+
+Get started with Tailwind by reading the ["Utility first" page](https://tailwindcss.com/docs/utility-first)
+
+## Help
+
+We provide help [on our Discord server](https://remotion.dev/discord).
+
+## Issues
+
+Found an issue with Remotion? [File an issue here](https://github.com/remotion-dev/remotion/issues/new).
+
+## License
+
+Note that for some entities a company license is needed. Read [the terms here](https://github.com/remotion-dev/remotion/blob/main/LICENSE.md).