6.0.0 • Published 5 years ago

@integreat-app/integreat-api-client v6.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
5 years ago

Integreat API-Client

Implementation of the integreat-cms endpoints (v3) used by the integreat-webapp and integreat-react-native-app.

Tasks of the API-Client:

  • Simple usage of the different endpoints
  • Fetching data from the cms
  • Mapping of the JSON responses to our internal models
  • Sorting and filtering when necessary
  • Posting feedback

Testing and Debugging

Apart from testing with unit tests you can test or debug your changes with the frontend of your choice:

  • Run yarn build.
  • Replace the content of node_modules > @integreat-app > integreat-api-client in the frontend with the content of the generated dist folder.

With bash you can use the following command from the parent directory to do so:

yarn --cwd integreat-api-client/ build && cp -R integreat-api-client/dist/. <frontend>/node_modules/@integreat-app/integreat-api-client/

This assumes:

  • <frontend> is either integreat-webapp or integreat-react-native-app.
  • integreat-api-client and <frontend> are both in the same directory.

Releasing

  • Bump the version number in the package.json.
    • Create a PR to the master branch.
    • Merge the PR, if necessary using admin privileges.
  • Run yarn build.
  • Navigate to the created dist folder (cd dist).
  • Make sure all necessary changes are present in the generated output:
    • Bumped version number.
    • Changes to be released.
  • Run yarn publish. Make sure to run this only from the dist folder.

NOTE: Publishing is only possible once per version number, so make sure everything is correct before running yarn start.

6.0.0

5 years ago

5.1.0

5 years ago

5.0.3

5 years ago

4.3.3

5 years ago

5.0.2

5 years ago

5.0.1

5 years ago

5.0.0

5 years ago

4.3.2

5 years ago

4.3.1

5 years ago

4.3.0

5 years ago

4.2.4

5 years ago

4.2.3

5 years ago

4.2.2

5 years ago

4.2.1

5 years ago

4.2.0

6 years ago

4.1.2

6 years ago

4.1.1

6 years ago

4.1.0

6 years ago

4.0.0

6 years ago

3.0.2

6 years ago

3.0.1

6 years ago

3.0.0

6 years ago

2.2.4

6 years ago

2.2.3

6 years ago

2.2.2

6 years ago

2.2.1

6 years ago

2.2.0

6 years ago

2.1.0

6 years ago

2.1.0-rc1

6 years ago

2.0.0

6 years ago

1.1.0-rc-2

6 years ago

1.1.0-rc-1

6 years ago

1.0.5

7 years ago

1.0.4

7 years ago

1.0.3

7 years ago

1.0.2

7 years ago

1.0.1

7 years ago

1.0.0

7 years ago