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

jjudgeclark/Project-Sample

 
 

Repository files navigation

License Community Website

INSTRUCTIONS: This GitHub repository serves as a template you can use to create a new project for the 2023 Call for Code Global Challenge. Use the Use this template button to create a new version of this repository and start entering content for your own Call for Code submission project. Make sure you have registered for the 2023 Call for Code Global Challenge to access resources and full project submission instructions. Remove any "INSTRUCTIONS" sections when you are ready to submit your project.

New to Git and GitHub? This free online course will get you up to speed quickly: Getting Started with Git and GitHub.

Replace this heading with your team/submission name

INSTRUCTIONS: Complete all required deliverable sections below.

Project summary

The issue we are hoping to solve

REPLACE THIS SENTENCE with a short description, 2-3 sentences in length, of the specific sustainability problem your solution is meant to address.

How our technology solution can help

REPLACE THIS SENTENCE with a short description of your team's solution, in about 10 words.

Our idea

INSTRUCTIONS: Replace this paragraph with a longer description of your solution. In about 500 words, describe your solution in more detail. Include the real-world problem you identified, describe the technological solution you have created, and explain how it’s an improvement over existing solutions. You can supply additional documentation in this source code repository that you link to as well.

More detail is available in our description document.

Technology implementation

IBM AI service(s) used

INSTRUCTIONS: Included here is a list of commonly used IBM AI services. Remove any services you did not use, or add others from the linked catalog not already listed here. Leave only those included in your solution code. Provide details on where and how you used each IBM AI service to help judges review your implementation. Remove these instructions.

Other IBM technology used

INSTRUCTIONS: List any other IBM technology used in your solution and describe how each component was used. If you can provide links to/details on exactly where these were used in your code, that would help the judges review your submission.

Solution architecture

Diagram and step-by-step description of the flow of our solution:

Video transcription/translaftion 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.

Presentation materials

INSTRUCTIONS: The following deliverables should be officially posted to your My Team > Submissions section of the Call for Code Global Challenge resources site, but you can also include them here for completeness. Replace the examples seen here with your own deliverable links.

Solution demo video

Watch the video

Project development roadmap

The project currently does the following things.

  • Feature 1
  • Feature 2
  • Feature 3

In the future we plan to...

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

Roadmap

Additional details

INSTRUCTIONS: The following deliverables are suggested, but optional. Additional details like this can help the judges better review your solution. Remove any sections you are not using.

How to run the project

INSTRUCTIONS: 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...

See our description document for log in credentials.


INSTRUCTIONS: You can remove the below section from your specific project README.

About this template

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%