Skip to content

Docs #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 75 commits into from
Oct 27, 2020
Merged

Docs #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
75 commits
Select commit Hold shift + click to select a range
ef12a76
docs: add nuxt docs
JoaoPedroAS51 Oct 19, 2020
e3037f5
docs: add introduction, installation, configuration, usage and nuxt e…
JoaoPedroAS51 Oct 19, 2020
3a3b373
docs: add api docs
JoaoPedroAS51 Oct 19, 2020
859e1b3
docs: update configuration and usage
JoaoPedroAS51 Oct 19, 2020
388638c
ci: add nodejs ci
JoaoPedroAS51 Oct 19, 2020
81f06e1
ci: fix setup node version
JoaoPedroAS51 Oct 19, 2020
e8707cb
chore(eslint): add .eslintignore
JoaoPedroAS51 Oct 19, 2020
44438a3
chore(scripts): add "lint" script
JoaoPedroAS51 Oct 19, 2020
e6f66f7
chore(scripts): add "test-watch" script
JoaoPedroAS51 Oct 19, 2020
c0698c4
Merge branch 'dev' into add-docs
JoaoPedroAS51 Oct 19, 2020
37e4fe1
ci(docs): update deploy action
JoaoPedroAS51 Oct 19, 2020
89a0413
ci: fix docs and publish
JoaoPedroAS51 Oct 19, 2020
0b035f8
Merge branch 'dev' into docs
JoaoPedroAS51 Oct 19, 2020
c303ced
ci: fix docs working directory
JoaoPedroAS51 Oct 19, 2020
b2812f5
docs: fix url
JoaoPedroAS51 Oct 19, 2020
3437f6e
docs: fix base url
JoaoPedroAS51 Oct 19, 2020
789d0d9
ci: fix docs action
JoaoPedroAS51 Oct 19, 2020
835be2d
Merge branch 'dev' into docs
JoaoPedroAS51 Oct 19, 2020
258ea83
docs: fix pages position
JoaoPedroAS51 Oct 19, 2020
c2dfc8d
chore(script): add `--coverage` flag to `test` script
JoaoPedroAS51 Oct 21, 2020
2220523
ci(publish): add step to upload coverage to codecov
JoaoPedroAS51 Oct 21, 2020
53796a1
chore(scripts): remove "prepare" script
JoaoPedroAS51 Oct 21, 2020
279f9dc
fix(model): add null check in `isValidId` (#115)
guirociozanini Oct 22, 2020
1bc6248
feat(model): handle 'data' wrapped responses for create and update (#…
fadugyamfi Oct 22, 2020
095c1c3
feat(model): add support to nested keys for relations (#127)
JoaoPedroAS51 Oct 22, 2020
460bfb5
chore: bump node-fetch from 2.6.0 to 2.6.1 (#124)
dependabot[bot] Oct 22, 2020
f3b81e6
Merge remote-tracking branch 'upstream/dev' into docs
JoaoPedroAS51 Oct 22, 2020
8802383
docs: update configuration and api options
JoaoPedroAS51 Oct 22, 2020
dbdcb6e
docs: update api docs
JoaoPedroAS51 Oct 22, 2020
c81454b
docs(model options): update docs
JoaoPedroAS51 Oct 22, 2020
0801c68
docs(query builder methods): update docs
JoaoPedroAS51 Oct 22, 2020
04bd9a8
docs(model options): add `primaryKey` default value
JoaoPedroAS51 Oct 22, 2020
7dad02a
docs(model options): fix typo
JoaoPedroAS51 Oct 22, 2020
7c5b6e7
docs(example): rename file of nuxt example
JoaoPedroAS51 Oct 22, 2020
56253d4
docs: remove usage section
JoaoPedroAS51 Oct 22, 2020
a6b87ed
docs: add building query section
JoaoPedroAS51 Oct 22, 2020
a20555f
chore: update package.json
JoaoPedroAS51 Oct 23, 2020
f470806
chore: update README.md
JoaoPedroAS51 Oct 23, 2020
87237af
docs: fix typo
JoaoPedroAS51 Oct 26, 2020
db69ffb
docs: add "including relationships"
JoaoPedroAS51 Oct 26, 2020
e0fafa7
docs: add helpers
JoaoPedroAS51 Oct 26, 2020
a1b4e6d
docs(operations): fix typo
JoaoPedroAS51 Oct 26, 2020
e40ffdd
docs(api): update query builder methods
JoaoPedroAS51 Oct 26, 2020
98aa8f5
docs: fix response of section "including relationships"
JoaoPedroAS51 Oct 26, 2020
94d8542
docs: add "appending attributes"
JoaoPedroAS51 Oct 26, 2020
6e04b5d
docs: add "selecting fields" and update other docs
JoaoPedroAS51 Oct 26, 2020
7a0312f
fix(utils): accept array of strings in param `propName` of `setProp`
JoaoPedroAS51 Oct 26, 2020
3c3e93b
test(utils): add tests for `setProp`
JoaoPedroAS51 Oct 26, 2020
7c4e565
fix(utils): fix `getProp`
JoaoPedroAS51 Oct 26, 2020
b365172
fix(utils): accept array of strings in param `propName` of `getProp`
JoaoPedroAS51 Oct 26, 2020
d5c25f0
test(utils): add tests for `getProp`
JoaoPedroAS51 Oct 26, 2020
e34ee1f
refactor(utils): update jsdocs of `getProp` and `setProp`
JoaoPedroAS51 Oct 26, 2020
0c12f01
refactor(test): remove semicolon
JoaoPedroAS51 Oct 26, 2020
0f92b16
docs: add "paginating" and add missing colons.
JoaoPedroAS51 Oct 26, 2020
d02a7f5
docs: add api reference to "selecting fields" section
JoaoPedroAS51 Oct 26, 2020
4f45706
docs: update "paginating" section
JoaoPedroAS51 Oct 26, 2020
d6934a4
docs: add "applying parameters"
JoaoPedroAS51 Oct 26, 2020
ce31cf9
docs: add "calling a custom resource"
JoaoPedroAS51 Oct 26, 2020
9a086c7
docs: add api reference of `params` and `custom`
JoaoPedroAS51 Oct 26, 2020
240da67
docs: add "composing without request"
JoaoPedroAS51 Oct 26, 2020
8d03374
docs: remove unnecessary responses
JoaoPedroAS51 Oct 26, 2020
c2c0551
docs: update "calling a custom resource"
JoaoPedroAS51 Oct 26, 2020
8205ae0
docs: fix crud order
JoaoPedroAS51 Oct 26, 2020
7021faa
docs: fix create request
JoaoPedroAS51 Oct 26, 2020
8d66628
docs: update example of delete operation
JoaoPedroAS51 Oct 26, 2020
31a0c89
docs: add "mixing everything up"
JoaoPedroAS51 Oct 26, 2020
d49aa90
docs: fix append example
JoaoPedroAS51 Oct 26, 2020
1ecd6da
docs: add "performing operations"
JoaoPedroAS51 Oct 27, 2020
e318449
docs: update `select` and `custom`
JoaoPedroAS51 Oct 27, 2020
d7b943d
docs: update model options
JoaoPedroAS51 Oct 27, 2020
bc4e8c0
docs: update configuration
JoaoPedroAS51 Oct 27, 2020
aead69c
docs: add vue example
JoaoPedroAS51 Oct 27, 2020
0e2c734
Merge branch 'dev' into docs
JoaoPedroAS51 Oct 27, 2020
62b6eae
docs: update "needless parent request"
JoaoPedroAS51 Oct 27, 2020
975f4da
docs: remove helpers
JoaoPedroAS51 Oct 27, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
build
coverage
138 changes: 138 additions & 0 deletions .github/workflows/nodejs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions

name: Node.js CI

on:
push:
branches: [ master, dev ]

pull_request:
branches: [ master, dev ]

jobs:
test:
name: Build & Test

runs-on: ${{ matrix.os }}

strategy:
matrix:
os: [ ubuntu-latest ]
node-version: [ 12.x, 14.x ]
fail-fast: true

steps:
- name: Checkout
uses: actions/checkout@v2

- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2-beta
with:
node-version: ${{ matrix.node-version }}

- name: Cache node_modules
id: cache-modules
uses: actions/cache@v2
with:
path: node_modules
key: ${{ matrix.node-version }}-${{ runner.OS }}-build-${{ hashFiles('yarn.lock') }}

- name: Install Dependencies
if: steps.cache-modules.outputs.cache-hit != 'true'
run: yarn install

- name: Lint
run: yarn lint

- name: Test
run: yarn test

publish:
name: Publish

needs: test

runs-on: ${{ matrix.os }}

if: github.event_name == 'push' && github.ref == 'refs/heads/master'

strategy:
matrix:
os: [ ubuntu-latest ]
fail-fast: true

steps:
- name: Checkout
uses: actions/checkout@v2

- name: Cache node_modules
id: cache-modules
uses: actions/cache@v2
with:
path: node_modules
key: 12.x-${{ runner.OS }}-build-${{ hashFiles('yarn.lock') }}

- name: Install Dependencies
if: steps.cache-modules.outputs.cache-hit != 'true'
run: yarn install

- name: Test
run: yarn test

- name: Upload Coverage to Codecov
uses: codecov/codecov-action@v1
with:
directory: ./coverage

- name: Publish to NPM
uses: mikeal/merge-release@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

docs:
name: Documentation

needs: test

runs-on: ${{ matrix.os }}

if: github.ref == 'refs/heads/master'

strategy:
matrix:
os: [ ubuntu-latest ]
node-version: [ 12.x ]
fail-fast: true

steps:
- name: Checkout
uses: actions/checkout@v2

- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2-beta
with:
node-version: ${{ matrix.node-version }}

- name: Cache node_modules
id: cache-modules-docs
uses: actions/cache@v2
with:
path: ./docs/node_modules
key: ${{ matrix.node-version }}-${{ runner.OS }}-build-${{ hashFiles('yarn.lock') }}

- name: Install Dependencies
if: steps.cache.outputs.cache-hit != 'true'
working-directory: ./docs
run: yarn install

- name: Generate
working-directory: ./docs
run: yarn generate

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/dist
Loading