https://github.com/tobysolutions/fleek-function-websocket-poc
A simple POC to showcase fleek functions opening websockets.
https://github.com/tobysolutions/fleek-function-websocket-poc
Last synced: 5 months ago
JSON representation
A simple POC to showcase fleek functions opening websockets.
- Host: GitHub
- URL: https://github.com/tobysolutions/fleek-function-websocket-poc
- Owner: tobySolutions
- Created: 2024-07-24T13:28:17.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-24T15:26:58.000Z (almost 2 years ago)
- Last Synced: 2025-03-09T13:37:20.659Z (over 1 year ago)
- Language: TypeScript
- Size: 69.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# React Boilerplate
## 🚀 Project Structure
Inside of your React project, you'll see the following folders and files:
```
/
├── public/
│ └── favicon.svg
├── src/
│ ├── assets/
│ ├── main.tsx
│ ├── App.tsx
│ └── App.css
├── index.html
├── tsconfig.json
├── vide.config.ts
└── package.json
```
If you want to learn more about `vite` and `react` you can checkout [Vite Documentation](https://vitejs.dev/).
## 🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
| :--------------------- | :----------------------------------------------- |
| `pnpm install` | Installs dependencies |
| `pnpm run dev` | Starts local dev server at `localhost:3000` |
| `pnpm run build` | Build your production site to `./dist/` |
| `pnpm run preview` | Preview your build locally, before deploying |
| `pnpm run lint ...` | Run Linter |
## ⚡ How to deploy to Fleek
### 1. Create a `fleek.json` config file:
You can configure this site deployment using [Fleek CLI]() and running:
```
> fleek sites init
WARN! Fleek CLI is in beta phase, use it under your own responsibility
? Choose one of the existing sites or create a new one. ›
❯ Create a new site
```
It will prompt you for a `name`, `dist` directory location & `build command`
- `name`: How you want to name the site
- `dist`: The output directory where the site is located, for this template it's `dist`
- `build command`: Command to build your site, this will be used to deploy the latest version either by CLI or Github Actions
### 2. Deploy the site
After configuiring your `fleek.json` file, you can deployt the site by running
```
fleek sites deploy
```
After running it you will get an output like this:
```
WARN! Fleek CLI is in beta, use it at your own discretion
> Success! Deployed!
> Site IPFS CID: QmP1nDyoHqSrRabwUSrxRV3DJqiKH7b9t1tpLcr1NTkm1M
> You can visit through the gateway:
> https://ipfs.io/ipfs/QmP1nDyoHqSrRabwUSrxRV3DJqiKH7b9t1tpLcr1NTkm1M
```
### Extra features
- **Continuous Integration (CI):** `fleek sites ci` [Documentation.](https://docs.fleek.xyz/services/sites/#continuous-integration-ci)
- **Adding custom domains:** `fleek domains create` [Documentation.](https://docs.fleek.xyz/services/domains/)
### Keep in mind:
This template has been configured to produce a static output.
```js
// vite.config.ts
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react-swc'
// https://vitejs.dev/config/
export default defineConfig({
plugins: [react()],
base: "./",
})
```
This means that assets will be pre-fixed with `./`, you can learn more about it in [Vite Documentation](https://vitejs.dev/config/shared-options.html#base)
## 👀 Want to learn more?
Feel free to check [React documentation](https://react.dev/) or [Vite Documentation](https://vitejs.dev/guide/).