Repository files navigation

A small recipe frontend application that demonstrates the simple usage of conjure tooling.

This example project uses the following tools and libraries, please consult their respective documentation for more information.

• conjure-typescript-runtime - conjure client bindings for typescript
• conjure-recipe-example-api - Generated Typescript API for the RecipeBookService
  • Generated and published byconjure-java-example fromthis conjure API
• yarn - a flexible build tool for frontend development

• conjure-recipe-example-app - a react application project that uses conjure generated typescript bindings for talking to a server that implements the same Conjure API

  This is what the project looks like:

  └── src/    ├── components/    ├── recipesApp.tsx    ├── services/    │   └── index.ts    └── store/        ├── actions/        ├── createStore.ts        ├── index.ts        ├── reducers/        ├── state/        └── state.ts

  • src/recipesApp.tsx - the main component of this app
  • src/components - defines react components
  • src/services - usesconjure-typescript-runtime and the generatedconjure-recipe-example-api to define a remoteRecipeBookService
  • src/store - defines the redux store for this app
    • src/store/actions - defines actions that are exported to the react app
    • src/store/reducers - defines reducers that implement the behaviour of the actions on the state
    • src/store/state - defines the state type hierarchy

gradle-conjure publishes conjure APIs to NPM (via thepublishTypeScript task), so you can depend on the APIlike any other package.

Make sure to also add a dependency onconjure-client in yourpackage.json:

   "dependencies": {     "@blueprintjs/core": "^3.0.1",+    "conjure-client": "^1.2.0",+    "conjure-recipe-example-api": "^0.2.0",     "react": "^16.4.1",     "react-dom": "^16.4.1",     "react-redux": "^5.0.7",

• yarn build to build and test the project
• yarn start to run a development build and start serving the app
• yarn lint --fix to fix any lint errors in the entire project

Please followthis section inconjure-java-example's readme.

This project was bootstrapped withCreate React App. Please refer to this guidehere for how to perform common tasks.