Google Git
Sign in
android / platform / frameworks / support / 8083f20603aacd54255d78851a3c40c8303ec67c / . / development / fetchLicenses
tree: b72db7ceb9291677e7f23fbd30d4988061fc8c15 [path history] [tgz]
  1. .vscode/
  2. .gcloudignore
  3. .gitignore
  4. .nvmrc
  5. app.yaml
  6. flags.ts
  7. index.ts
  8. license.ts
  9. logger.ts
  10. package-lock.json
  11. package.json
  12. plain_text_formatter.ts
  13. README.md
  14. tsconfig.json
  15. types.ts
development/fetchLicenses/README.md

Fetch Licenses

A service that makes license files readable using headless Chrome.

Setup

  • This project uses TypeScript and Node.
  • Download nvm and run nvm install to install a suitable version of Node.
  • Run npm install to setup dependencies.
  • Use Visual Studio code to debug and test.

Testing

Local debugging

Run the web service locally using the provided package scripts. Run npm run-script debug and this spins up a local web server. You can use Visual Studio code to attach to this process. nodemon and tsc --watch compiles and restarts your service as you are making changes to the source code automatically in debug mode.

Example HTTP Request

curl -d '{"url": "https://opensource.org/licenses/bsd-license.php"}' -H 'Content-Type: application/json' -X POST 'http://localhost:8080/convert/licenses'

Deploy

  • Install the gcloud CLI.
  • Run npm run-script setupGcpProject to setup credentials.
  • Run npm run-script deploy to deploy the project to App Engine.