Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nachat-ayoub committed Feb 20, 2024
1 parent 2cc7b44 commit 86f8aea
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 26 deletions.
55 changes: 55 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ['main']

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets the GITHUB_TOKEN permissions to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow one concurrent deployment
concurrency:
group: 'pages'
cancel-in-progress: true

jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Node
uses: actions/setup-node@v3
with:
node-version: 18
cache: 'npm'
- name: Install dependencies
run: npm install
- name: Build
run: npm run build
env:
VITE_SERVICE_ID: ${{ secrets.VITE_SERVICE_ID }}
VITE_TEMPLATE_ID: ${{ secrets.VITE_TEMPLATE_ID }}
VITE_PUBLIC_KEY: ${{ secrets.VITE_PUBLIC_KEY }}
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
# Upload dist repository
path: './dist'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
36 changes: 10 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,14 @@
# React + TypeScript + Vite
# Would You Rather Shorts Generator
The "Would You Rather" Short Videos Generator is a powerful tool that automatically generates engaging 60-second videos suitable for platforms like YouTube Shorts, TikTok, Facebook and Instagram Reels. Built with Node.js, EJS, canvas. this dynamic generator. Explore the live demo here.

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
<br>

Currently, two official plugins are available:
# Demo
https://nachat-ayoub.github.io/wyr-shorts-generator

<br>

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
# [Contact me](mailto:ayoub.nachat.27@gmail.com)

## Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:

- Configure the top-level `parserOptions` property like this:

```js
export default {
// other rules...
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
project: ['./tsconfig.json', './tsconfig.node.json'],
tsconfigRootDir: __dirname,
},
}
```

- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
<br>
<br>

0 comments on commit 86f8aea

Please sign in to comment.