anthonyraudino / otoeng-web

The Otohime site web front-end, written in TypeScript / React.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

The Otohime front-end

The main branch is under huge rewrite and may not function as expected. Please refer to the legacy branch or latest release tag for a working version.

It is a TypeScript / React project.

Get Started

Register and set:

  • Facebook Login
  • Firebase Auth connecting with Facebook

Make sure the server is up with docker-compose and .env set correctly. In order to import the score correctly, please check documents of the server.

Then create src/firebase.ts with contents like:

export default {
  apiKey: ".......",
  authDomain: "project-name.firebaseapp.com",
  databaseURL: "https://project-name.firebaseio.com",
  projectId: "project-name",
  storageBucket: "project-name.appspot.com",
  messagingSenderId: "............",
  appId: ".........",
  measurementId: ".....",
}

Install the dependencies:

npm install

Run the dev server with:

npm start

Firebase Auth requires HTTPS, so the dev server is set to use HTTPS by default.

License

Copyright (c) 2018 - 2023 Otohime Team (Hsiao-Ting Yu and others)

Licensed under MIT license, see LICENSE.md.

Artworks in public/favicon.ico, src/logo, src/dx_intl/images/course_ranks and src/dx_intl/images/class_ranks, src/dx_intl/images/ratings are released separately:

(C) 2021-2022 Akanyan, released under CC-BY 4.0 International

Logos are generated with RealFaviconGenerator.net.

About

The Otohime site web front-end, written in TypeScript / React.

License:MIT License


Languages

Language:TypeScript 97.5%Language:CSS 2.0%Language:JavaScript 0.3%Language:SCSS 0.1%Language:HTML 0.1%Language:Shell 0.0%