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 register for Call for Code 2021!
Read this in other languages: English, 한국어, português.
- Short description
- Demo video
- The architecture
- Long description
- Project roadmap
- Getting started
- Live demo
- Built with
- Contributing
- Versioning
- Authors
- License
- Acknowledgments
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.
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.
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.
- The user navigates to the site and uploads a video file.
- Watson Speech to Text processes the audio and extracts the text.
- Watson Translation (optionally) can translate the text to the desired language.
- The app stores the translated text as a document within Object Storage.
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.
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.
You can find a running system to test at callforcode.mybluemix.net.
- IBM Cloudant - The NoSQL database used
- IBM Cloud Functions - The compute platform for handing logic
- IBM API Connect - The web framework used
- Dropwizard - The web framework used
- Maven - Dependency management
- ROME - Used to generate RSS Feeds
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Billie Thompson - Initial work - PurpleBooth
This project is licensed under the Apache 2 License - see the LICENSE file for details.
- Based on Billie Thompson's README template.