https://github.com/enmanuelmag/streamfy
Streamfy is a web app to help streamers to make activities more easily and fun for their audience
https://github.com/enmanuelmag/streamfy
activities stream
Last synced: over 1 year ago
JSON representation
Streamfy is a web app to help streamers to make activities more easily and fun for their audience
- Host: GitHub
- URL: https://github.com/enmanuelmag/streamfy
- Owner: enmanuelmag
- License: other
- Created: 2024-02-07T02:51:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-18T14:31:55.000Z (about 2 years ago)
- Last Synced: 2025-01-31T22:52:36.555Z (over 1 year ago)
- Topics: activities, stream
- Language: TypeScript
- Homepage: https://streamfy.cardor.dev
- Size: 2.38 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Streamfy
[](https://github.com/enmanuelmag/Streamfy/actions/workflows/ci.yml)
[](https://github.com/enmanuelmag/Streamfy/actions/workflows/cloud_functions.yml)
## 🚨🚨 IMPORTANT 🚨🚨
[Video tutorial](https://youtu.be/3pEWZ9V5Wh0)
You need to login with a Discord account to use the app. The reason is to fetch the user's guilds that the user is part of, and then fetch the channels of the guilds to show the user the channels that the user can join to watch the stream.
The unique information used from Discord account is: email, username, avatar and the guilds that the user is part of.
Also the Streamfy's bot must be in the guild to fetch the data. You can invite the bot to your guild with the following link: [Invite Streamfy](https://discord.com/api/oauth2/authorize?client_id=1204867795813404703&permissions=74816&scope=bot)
## Requirements
- Install [NodeJs](https://nodejs.org/en) >= v20.
- Add the .env file inside the folder `global/env`, you see the template with the required variables in the file env.template that's in the sabe folder `global/env`.
## Installation
Here are three npm projects, to install all the dependencies run the following command in the only root folder, no more commands for installation are required after this:
```Bash
npm i
```
## Development mode
Then, to start the development server, first is necessary to run build global deps:
```Bash
npm run global:build
```
Then, run the following command:
```Bash
npm run dev
```
## Production mode
To build the project, is necessary to build the whole project:
```Bash
npm run build
```
Then to start the built project:
```Bash
npm run start
```
# What's in the boilerplate
> Boilerplate for React/Typescript/Express/Zustand, built on top of Vite ⚡️
- [Vite](https://vitejs.dev/)
- [React](https://reactjs.org/)
- [Typescript](https://www.typescriptlang.org/)
- [Vitest](https://vitest.dev/)
- [Testing Library](https://testing-library.com/)
- [Zustand](https://zustand-demo.pmnd.rs)
- Dev Tools
- [ESLint](https://eslint.org/)
- [Prettier](https://prettier.io/)
- [CommitLint](https://commitlint.js.org/#/)
- [Husky](https://typicode.github.io/husky/#/)
- [Lint-Staged](https://github.com/okonet/lint-staged)
# License
MIT