CodeTranslate is a one-stop site for developers to rapidly scale-up in unfamiliar languages without having to memorize syntax, follow tutorials, or read documentation. It is “Google Translate” for code: a developer can type code in a known language and see the translation for an unfamiliar language.
Check out our live demo at http://demo.codetranslate.com/. The repository for the frontend of the demo can be found here. Please note that the demo is currently hosted for free on Heroku and may take some time to load up.
We welcome use of our public api so that you can integrate code translations into your own projects! Check out our API Documentation if you are interested.
- Clone this repository (how to clone)
cd cjs_capstone- make sure you have all prerequisites installed
- To run tests:
pytest - To run api locally:
python app.py
The main pre-requisite is that you have pip installed. Install pip. Once you have pip installed, take the following steps:
- make sure you are in the root directory
- create a virtual enviornment in python 3
- copy-paste the following into terminal:
$ pip install -r requirements.txt # for running server
$ pip install -U pytest # for testing
$ pip install yapf # for auto formatting
- Download service key from firebase project
- Select generate new key button
- Download to
private_keys/firebase-access-key.json python tools/add_environ_var.py
As languages are added to this codebase, we encourage developers to add test cases to go along with their additions. For each language feature added in a new language, three types of tests should be addded:
- End to end integration tests with other languages
- Code to generic AST tests
- Generic AST to code tests
To add to an integration test case, a new Unittest object needs to be made following the pattern of the test cases already there. With this object the developer needs to decide if they want to test the code as an input command, output command, or both. Then, add code to GAST and GAST to code tests in a separate file for each language. The GASTs for current supported commands are already written out and can be found at test/gasts.py.
The generic AST (gast) is a tree structured JSON file that is able to serve as a common-ground between the AST's of multiple languages. This is important because it allows the developers to think of the translation as a series of black boxes. For each supported language, there is the translation from the language to the gast and the translation from the gast back to the language. As long as the gast is agreed upon, developers can easily split up the work for the two parts of the translation without running into issues. The stable nature of the gast also means that adding new languages should not affect previously written code.
For each language feature that we wanted to support, we sat down and looked at the AST's for various languages. Using elements across AST's, we then wrote the structure for our gast, adding it to our "contract" document. This contract document served to both coordinate our efforts and also functioned as the basis for our testing. Once added to our contract, we linked to it in our GAST Design Doc and provided justification for the design choices we made.
For information on how to contribute, please refer to CONTRIBUTING.md
- Cory O'Shea - Founding Contributor - Portfolio | Github
- Jack Weber - Founding Contributor -- Portfolio | Github
- Steph Walsh - Founding Contributor - Portfolio | Github
- Danish Noorani - Founding Advisor
- Gabriel Harel - Founding Advisor
- Michael Auger - Founding Advisor
See also the list of contributors who participated in this project.
First and foremost, we want to thank and acknowledge our intern hosts (Danish, Gabriel, and Michael) who guided us and mentored us through every step of our 12 week internship. Thank you for such an amazing experience!
We would also like to acknowledge:
- Dave Baum for his Level Up Coding lessons
- Google STEP Intern Program
- Google SURF Chicago Team
This project is licensed under the MIT License - see the LICENSE file for details