Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 2.14 KB

README.md

File metadata and controls

37 lines (23 loc) · 2.14 KB
KoelLabsLogoLong

Mozilla Builders Patreon PayPal

Koel Labs - Web Application

Zizmor Gitleaks Secret Scanning Automatic Deploys

Contains the website for Koel Labs and the web interface for the pronunciation learning application.

Read about all our repositories here.

Setup

See DEVELOPMENT.md for how to setup your local development environment. If you just want to run the application locally not for development purposes, follow the instructions below.

  1. git clone /~https://github.com/KoelLabs/webapp.git
  2. Install Docker and Docker Compose
  3. Duplicate the .env.example file and rename it to .env.local with cp .env.example .env.local.
    • The default values should work to get started. You can optionally change DEV_LOGIN to include your username and email.
  4. Run the application . ./scripts/docker-run-dev.sh

Contributing

Check out CONTRIBUTING.md for specific guidelines on contributing to this repository.

We are grateful for all of our contributors. If you contribute to this repository and wish to be acknowledged, please add your name to the list in your pull request.

License

Application code in this repository is open-sourced under the FSL-1.1-Apache-2.0.

We retain all rights to the Koel Labs brand, logos, blog posts, and website content.