-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 11b0d7c
Showing
51 changed files
with
8,427 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
PUBLIC_FIREBASE_API_KEY="AIzaSyA1YtQNcg8tfI1MqS9KdZMaUTtcqNEoEMw" | ||
PUBLIC_FIREBASE_AUTH_DOMAIN="hinagiku-dev.firebaseapp.com" | ||
PUBLIC_FIREBASE_PROJECT_ID="hinagiku-dev" | ||
PUBLIC_FIREBASE_STORAGE_BUCKET="hinagiku-dev.firebasestorage.app" | ||
PUBLIC_FIREBASE_MESSAGING_SENDER_ID="585902608528" | ||
PUBLIC_FIREBASE_APP_ID="1:585902608528:web:908698a423651bb865c815" | ||
PUBLIC_FIREBASE_MEASUREMENT_ID="G-QFXF543DV8" | ||
|
||
GOOGLE_APPLICATION_CREDENTIALS="service-account-file.example.json" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Auto detect text files and perform LF normalization | ||
* text=auto |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
name: CI | ||
|
||
on: | ||
pull_request: | ||
branches: | ||
- main | ||
push: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@v4 | ||
|
||
- uses: pnpm/action-setup@v4 | ||
with: | ||
run_install: true | ||
|
||
- name: Run lint | ||
run: pnpm lint | ||
|
||
- name: Copy fake .env | ||
run: cp .env.example .env | ||
|
||
- name: Run build | ||
run: pnpm build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
node_modules | ||
|
||
# Output | ||
.output | ||
.vercel | ||
/.svelte-kit | ||
/build | ||
|
||
# OS | ||
.DS_Store | ||
Thumbs.db | ||
|
||
# Env | ||
.env | ||
.env.* | ||
!.env.example | ||
!.env.test | ||
|
||
# Vite | ||
vite.config.js.timestamp-* | ||
vite.config.ts.timestamp-* | ||
|
||
.pnpm-store | ||
|
||
service-account-file.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
pnpm lint-staged |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
engine-strict=true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
{ | ||
"useTabs": true, | ||
"singleQuote": true, | ||
"trailingComma": "none", | ||
"printWidth": 100, | ||
"plugins": [ | ||
"prettier-plugin-svelte", | ||
"prettier-plugin-organize-imports", | ||
"prettier-plugin-tailwindcss" | ||
], | ||
"overrides": [ | ||
{ | ||
"files": "*.svelte", | ||
"options": { | ||
"parser": "svelte" | ||
} | ||
} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# Hinagiku | ||
|
||
Hinagiku (雛菊), or Daisy in English, is an intelligent system designed to support discussions in educational environments. One of Hinagiku's key features is its real-time voice transcription and analysis, which helps hosts provide timely and insightful feedback, setting it apart from other educational tools. We chose the name Hinagiku because it reflects our core values: resilience, simplicity, and growth—much like the daisy flower itself, which flourishes in diverse conditions. Our mission is to help participants and hosts connect meaningfully by providing tools that facilitate better communication and collaboration in classrooms. | ||
|
||
## Development Instructions | ||
|
||
To set up the development environment for Hinagiku, please follow these steps: | ||
|
||
### Install dependencies | ||
|
||
Ensure you have `pnpm` installed. If not, you can install it using the script: | ||
|
||
```sh | ||
curl -fsSL https://get.pnpm.io/install.sh | sh - | ||
``` | ||
|
||
> See <https://pnpm.io/installation> for more details | ||
Then, install the project dependencies: | ||
|
||
```sh | ||
pnpm install | ||
``` | ||
|
||
### Set up environment variables and files | ||
|
||
Create a `.env` file in the root directory of the project and copy the contents from `.env.example`: | ||
|
||
```sh | ||
cp .env.example .env | ||
``` | ||
|
||
Ensure the environment variables are correctly set in the `.env` file. | ||
|
||
Ensure that the `GOOGLE_APPLICATION_CREDENTIALS` file exists in the root directory of the project. This file is necessary for Firebase Admin SDK to authenticate. | ||
|
||
By following these steps, you will be able to set up and run the Hinagiku project locally for development purposes. | ||
|
||
### Run the development server | ||
|
||
Start the development server using the following command: | ||
|
||
```sh | ||
pnpm dev | ||
``` | ||
|
||
### Lint and format the code | ||
|
||
Ensure your code adheres to the project's linting and formatting rules: | ||
|
||
```sh | ||
pnpm lint | ||
pnpm format | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
import js from '@eslint/js'; | ||
import prettier from 'eslint-config-prettier'; | ||
import svelte from 'eslint-plugin-svelte'; | ||
import globals from 'globals'; | ||
import ts from 'typescript-eslint'; | ||
|
||
export default ts.config( | ||
js.configs.recommended, | ||
...ts.configs.recommended, | ||
...svelte.configs['flat/recommended'], | ||
prettier, | ||
...svelte.configs['flat/prettier'], | ||
{ | ||
languageOptions: { | ||
globals: { | ||
...globals.browser, | ||
...globals.node | ||
} | ||
} | ||
}, | ||
{ | ||
files: ['**/*.svelte'], | ||
|
||
languageOptions: { | ||
parserOptions: { | ||
parser: ts.parser | ||
} | ||
} | ||
}, | ||
{ | ||
ignores: ['build/', '.svelte-kit/', 'dist/'] | ||
} | ||
); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
{ | ||
"private": true, | ||
"name": "hinagiku", | ||
"version": "0.0.1", | ||
"type": "module", | ||
"scripts": { | ||
"prepare": "husky", | ||
"dev": "vite dev", | ||
"build": "vite build", | ||
"preview": "vite preview", | ||
"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json", | ||
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch", | ||
"format": "prettier --ignore-path .gitignore --write .", | ||
"lint": "prettier --ignore-path .gitignore --check . && eslint ." | ||
}, | ||
"devDependencies": { | ||
"@sveltejs/adapter-auto": "^3.3.1", | ||
"@sveltejs/kit": "^2.7.7", | ||
"@sveltejs/vite-plugin-svelte": "^4.0.0", | ||
"@tailwindcss/typography": "^0.5.15", | ||
"@types/eslint": "^9.6.1", | ||
"@types/qrcode": "^1.5.5", | ||
"autoprefixer": "^10.4.20", | ||
"eslint": "^9.14.0", | ||
"eslint-config-prettier": "^9.1.0", | ||
"eslint-plugin-svelte": "^2.46.0", | ||
"firebase": "^11.0.1", | ||
"firebase-admin": "^12.7.0", | ||
"globals": "^15.12.0", | ||
"html5-qrcode": "^2.3.8", | ||
"husky": "^9.1.6", | ||
"lint-staged": "^15.2.10", | ||
"lucide-svelte": "^0.454.0", | ||
"mdsvex": "^0.11.2", | ||
"prettier": "^3.3.3", | ||
"prettier-plugin-organize-imports": "^4.1.0", | ||
"prettier-plugin-svelte": "^3.2.7", | ||
"prettier-plugin-tailwindcss": "^0.6.8", | ||
"qrcode": "^1.5.4", | ||
"svelte": "^5.1.10", | ||
"svelte-check": "^4.0.5", | ||
"tailwindcss": "^3.4.14", | ||
"typescript": "^5.6.3", | ||
"typescript-eslint": "^8.13.0", | ||
"vite": "^5.4.10" | ||
}, | ||
"lint-staged": { | ||
"*.{yml,yaml,json,js,ts,css,html,svelte}": [ | ||
"prettier --write", | ||
"eslint --fix" | ||
] | ||
}, | ||
"packageManager": "pnpm@9.12.3" | ||
} |
Oops, something went wrong.