Skip to content

pojntfx/learn-chinese-platform

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Learn Chinese Platform

Learn Chinese Platform Logo

A modern and libre way to learn Chinese.

Usage

Demo Site Developed on GNU/Linux

# Install dependencies
$ npm install
# Start development versions of all packages
$ npm run dev
# Start development versions of and debugger for all packages (connect by pressing F5 in VSCode)
$ npm run dev--debug
# Start development version of inidividual package
$ npm run dev -- --scope @learn-chinese-platform/gateway
# Start development version of and debugger for individual package (connect by pressing F5 in VSCode)
$ npm run dev--debug -- --scope @learn-chinese-platform/core

Deployment

Built for GNU/Linux Built for Docker Built for Kubernetes Built for Exoframe

# Build production versions of all packages
$ npm run build
# Start production versions of all packages
$ npm run start
# Build production version of inidividual package
$ npm run build -- --scope @learn-chinese-platform/gateway
# Start production version of inidividual package
$ npm run start -- --scope @learn-chinese-platform/gateway
# Publish all packages to npm
$ npm run publish
# Install deployment dependencies
$ npm install -g exoframe
# Connect to the Learn Chinese Platform's Exoframe
$ exoframe endpoint https://exoframe.services.learn-chinese.tk
$ exoframe login
# Deploy all services to Exoframe
$ npm run deploy # No logs, just sit tight until it finishes (~10 minutes)
# Deploy individual service to Exoframe
$ npm run deploy -- --scope @learn-chinese-platform/gateway

Contributing

See CONTRIBUTING.md.

Credits

The following FLOSS libraries, among many others, have played an especially important role in the development of the Learn Chinese Platform:

Thanks to everyone who contributes to these libraries!

Licenses

Code License AGPL-3.0 Media License CC-BY-SA-4.0

These licenses do, if not otherwise specified, apply to all packages in this repository.

Code

AGPL-3.0 License

Learn Chinese Platform Copyright (C) 2018 Felix Pojtinger

SPDX-License-Identifier: AGPL-3.0

This program is free software: you can redistribute it and/or modify it under the terms of the GNU/Linux Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU/Linux Affero General Public License for more details.

You should have received a copy of the GNU/Linux Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Media

CC-BY-SA-4.0 License

Learn Chinese Platform Copyright (C) 2018 Felix Pojtinger

SPDX-License-Identifier: CC-BY-SA-4.0

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.