diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml new file mode 100644 index 0000000..792eb4c --- /dev/null +++ b/.github/workflows/nodejs.yml @@ -0,0 +1,30 @@ +# This workflow will do a clean install of node dependencies, cache/restore them, 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: Build & Deploy + +on: + push: + branches: [ main, graphql, kickstarter, typescript, express/rest, pipeline] + pull_request: + branches: [ main, graphql, kickstarter, typescript, express/rest ] + +jobs: + build: + runs-on: ubuntu-latest + strategy: + matrix: + os: [ubuntu-latest, macos-latest, windows-latest] + node-version: [12.x, 14.x, 15.x, 16.x] + # See supported Node.js release schedule at https://nodejs.org/en/about/releases/ + steps: + - uses: actions/checkout@v2 + - name: Use Node.js ${{ matrix.node-version }} on ${{ matrix.os }} + uses: actions/setup-node@v2 + with: + node-version: ${{ matrix.node-version }} + - run: npm install + - run: npm run linter --if-present + - run: npm run build --if-present + - run: npm run dev & sleep 3 + - run: npm run start & sleep 3 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..305630a --- /dev/null +++ b/.gitignore @@ -0,0 +1,25 @@ +# Build and Release Folders +bin-debug/ +bin-release/ +[Oo]bj/ +[Bb]in/ + +# Other files and folders +.settings/ +node_modules/ +.env +dist/ +package-lock.json + +# Executables +*.swf +*.air +*.ipa +*.apk +*.env + +# Project files, i.e. `.project`, `.actionScriptProperties` and `.flexProperties` +# should NOT be excluded as they contain compiler settings and other important +# information for Eclipse / Flash Builder. +node_modules +.DS_Store diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Procfile b/Procfile new file mode 100644 index 0000000..e8f79ea --- /dev/null +++ b/Procfile @@ -0,0 +1 @@ +web: npm start \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..c4bef6e --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# backend-boilerplate +Nodejs ES6 Backend Boilerplate diff --git a/app.js b/app.js new file mode 100644 index 0000000..6f5306c --- /dev/null +++ b/app.js @@ -0,0 +1,16 @@ +import { GraphQLServer, PubSub } from 'graphql-yoga'; +import resolvers from './src/resolvers/index'; + +const pubsub = new PubSub(); +const server = new GraphQLServer({ + typeDefs: `${__dirname}/src/schema.graphql`, + resolvers, + context(request) { + return { + pubsub, + request + }; + } +}); + +server.start(() => console.log('Server is listening at localhost:4000')); diff --git a/config.js b/config.js new file mode 100644 index 0000000..f851825 --- /dev/null +++ b/config.js @@ -0,0 +1 @@ +require('dotenv').config(); diff --git a/package.json b/package.json new file mode 100644 index 0000000..ff8c974 --- /dev/null +++ b/package.json @@ -0,0 +1,60 @@ +{ + "name": "nodejs-backend-boilerplate", + "version": "1.0.0", + "description": "Nodejs GraphQL App(ES6) Backend Boilerplate", + "author": "Salman Dabbakuti", + "license": "ISC", + "dependencies": { + "dotenv": "8.2.0", + "esm": "3.2.25", + "graphql-yoga": "^1.18.3" + }, + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1", + "linter": "eslint .", + "start": "node -r esm app.js", + "dev": "nodemon -r esm app.js --ext js,graphql" + }, + "devDependencies": { + "eslint": "^7.24.0", + "eslint-plugin-import": "2.22.1", + "eslint-config-airbnb-base": "^14.2.1", + "babel-eslint": "^10.1.0", + "nodemon": "^2.0.7" + }, + "eslintConfig": { + "extends": "airbnb-base", + "parser": "babel-eslint", + "parserOptions": { + "ecmaVersion": 6, + "sourceType": "module" + }, + "rules": { + "linebreak-style": "off", + "no-unused-vars": "warn", + "no-console": "off", + "no-await-in-loop": "warn", + "no-restricted-syntax": "off", + "import/prefer-default-export": "warn", + "new-cap": "warn", + "max-len": "off", + "object-curly-newline": "off", + "no-return-await": "error", + "no-param-reassign": "warn", + "semi": "warn", + "no-use-before-define": "error", + "indent": [ + 2 + ], + "comma-dangle": [ + "warn", + "never" + ] + }, + "env": { + "node": true, + "browser": true, + "es6": true + } + } +} diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..f45d8f1 --- /dev/null +++ b/renovate.json @@ -0,0 +1,5 @@ +{ + "extends": [ + "config:base" + ] +} diff --git a/src/authorization/utils.js b/src/authorization/utils.js new file mode 100644 index 0000000..e69de29 diff --git a/src/resolvers/index.js b/src/resolvers/index.js new file mode 100644 index 0000000..bf881b0 --- /dev/null +++ b/src/resolvers/index.js @@ -0,0 +1,11 @@ +import Query from './query'; +import Mutation from './mutation'; +import Subscription from './subscription'; + +const resolvers = { + Query, + Mutation, + Subscription +}; + +export default resolvers; diff --git a/src/resolvers/mutation.js b/src/resolvers/mutation.js new file mode 100644 index 0000000..c605ccc --- /dev/null +++ b/src/resolvers/mutation.js @@ -0,0 +1,9 @@ +const Mutation = { + + async hello(parent, args, { pubsub }) { + pubsub.publish('notification', { notification: 'Hello Graphql Subscription!' }); + return 'Hello GraphQL!'; + } +}; + +export default Mutation; diff --git a/src/resolvers/query.js b/src/resolvers/query.js new file mode 100644 index 0000000..041809b --- /dev/null +++ b/src/resolvers/query.js @@ -0,0 +1,7 @@ +const Query = { + + async hello() { + return 'Hello GraphQL!'; + } +}; +export default Query; diff --git a/src/resolvers/subscription.js b/src/resolvers/subscription.js new file mode 100644 index 0000000..eb1d5db --- /dev/null +++ b/src/resolvers/subscription.js @@ -0,0 +1,10 @@ +const Subscription = { + + notification: { + async subscribe(parent, args, { pubsub }) { + return pubsub.asyncIterator('notification'); + } + } +}; + +export default Subscription; diff --git a/src/schema.graphql b/src/schema.graphql new file mode 100644 index 0000000..5f634fa --- /dev/null +++ b/src/schema.graphql @@ -0,0 +1,13 @@ +scalar Json +scalar Date + +type Query { + hello: String! +} +type Mutation { + hello: String! +} + +type Subscription { + notification: String! +} \ No newline at end of file