Skip to content

A basic GitHub repository example for new Call for Code submissions and those that join the Call for Code with The Linux Foundation initiative.

License

Notifications You must be signed in to change notification settings

fenxu/Project-Sample

 
 

Repository files navigation

Submission or project name

License Community Website

A basic GitHub repository example for new Call for Code projects and those that join the Call for Code with The Linux Foundation deployment initiative. Not all sections or files are required. You can make this as simple or as in-depth as you need. And don't forget to join the Call for Code community.

If you're new to open source, please consider taking the free "Introduction to Open Source" class.

Open Source Foundations

Read this in other languages: English, 한국어, português.

Contents

Short description

What's the problem?

Part of the World Health Organization's guidance on limiting further spread of COVID-19 is to practice social distancing. As a result, schools in most affected areas are taking precautionary measures by closing their facilities. With school-aged children at home for an indeterminate amount of time, keeping them engaged, entertained, and on top of their education is important.

How can technology help?

Schools and teachers can continue to engage with their students through virtual classrooms, and even create interactive spaces for classes. As parents face a new situation where they may need to homeschool their children, finding appropriate online resources is important as well.

The idea

It's imperative that learning and creating can continue when educational institutions have to shift the way they teach in times of crises, such as the COVID-19 pandemic. Providing a set of open source tools, backed by IBM Cloud and Watson Services, will enable educators to more easily make content available for their students.

Demo video

Watch the video

The architecture

Video transcription/translation app

  1. The user navigates to the site and uploads a video file.
  2. Watson Speech to Text processes the audio and extracts the text.
  3. Watson Translation (optionally) can translate the text to the desired language.
  4. The app stores the translated text as a document within Object Storage.

Long description

More detail is available here

Project roadmap

The project currently does the following things.

  • Feature 1
  • Feature 2
  • Feature 3

It's in a free tier IBM Cloud Kubernetes cluster. In the future we plan to run on Red Hat OpenShift, for example.

See below for our proposed schedule on next steps after Call for Code 2021 submission.

Roadmap

Getting started

In this section you add the instructions to run your project on your local machine for development and testing purposes. You can also add instructions on how to deploy the project in production.

Live demo

You can find a running system to test at callforcode.mybluemix.net.

See the "long description" field in our submission (not in this repo) for the log-in credentials.

Built with

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

License

This project is licensed under the Apache 2 License - see the LICENSE file for details.

Acknowledgments

About

A basic GitHub repository example for new Call for Code submissions and those that join the Call for Code with The Linux Foundation initiative.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 42.7%
  • HTML 26.0%
  • JavaScript 24.1%
  • CSS 7.2%