feat: gitpodify project (#189)

* feat: init gitpodify

* fix: authentication to env-variable

* fix: test authentication

* fix: adjust other actions

* feat: adjust gitpod.yml

* feat: script order

* fix: adjust gitpod.yml

* fix: adjust gitpod.yml

* fix: adjust gitpod.yml

* fix: adjust gitpod.yml

* feat: update gitpod.yml

* revert: remove await port

* feat: add delay

* fix: delay to sleep

* feat: remove preview

* feat: update dockerfile

* docs: update readme

* feat: add gitpod button

* feat: adjust prebuild settings

Co-authored-by: Cahllagerfeld <Cahllagerfeld>

Author: Cahllagerfeld

.github/workflows/build.yml

@@ -12,11 +12,10 @@ jobs:
       - uses: actions/setup-node@v2
         with:
           node-version: '16'
-      - name: Authenticate with GitHub package registry
-        run: echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" > ~/.npmrc
       - name: install dependencies
         run: npm ci
         env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
       - name: lint check
         run: npm run lint
@@ -31,11 +30,10 @@ jobs:
       - uses: actions/setup-node@v2
         with:
           node-version: '16'
-      - name: Authenticate with GitHub package registry
-        run: echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" > ~/.npmrc
       - name: install dependencies
         run: npm ci
         env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
       - name: run build
         run: npm run build
@@ -65,11 +63,10 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
-      - name: Authenticate with GitHub package registry
-        run: echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" > ~/.npmrc
       - name: install dependencies
         run: npm ci
         env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
       - name: run unit tests
         run: npm run test

.github/workflows/docker.yml

@@ -8,11 +8,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - name: Authenticate with GitHub package registry
-        run: echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" > ~/.npmrc
-      - name: npm install
+      - name: install dependencies
         run: npm ci
         env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
       - name: npm build
         run: npm run build
@@ -40,8 +39,6 @@ jobs:
         node-version: [16.x]
     steps:
       - uses: actions/checkout@v2
-      - name: Authenticate with GitHub package registry
-        run: echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" > ~/.npmrc
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v2
         with:
@@ -50,9 +47,10 @@ jobs:
         with:
           name: artifacts
           path: dist
-      - name: npm install
+      - name: install dependencies
         run: npm ci
         env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
       - name: test
         run: npm test
@@ -83,6 +81,8 @@ jobs:
         with:
           context: .
           push: true
+          secrets: |
+            'GH_TOKEN=${{ secrets.GITHUB_TOKEN }}'
           build-args: 'github_token=${{ secrets.GITHUB_TOKEN }}'
           tags: |
             ghcr.io/eddiehubcommunity/api:v${{ steps.package-version.outputs.current-version}}

.github/workflows/docs.yml

@@ -13,10 +13,11 @@ jobs:
       - uses: actions/setup-node@v2
         with:
           node-version: '16'
-      - name: Authenticate with GitHub package registry
-        run: echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" > ~/.npmrc
       - name: install dependencies
         run: npm ci
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
       - name: build docs
         run: npm run docs
 

.gitpod.yml

@@ -0,0 +1,31 @@
+# List the start up tasks. Learn more https://www.gitpod.io/docs/config-start-tasks/
+tasks:
+  - name: Install npm depdencies
+    init: |
+      npm i -g npm
+      npm install
+    command: |
+      npm i -g npm
+      sleep 30
+      npm run start:dev
+  - name: Docker
+    command: |
+      docker-compose up
+      
+
+github:
+  prebuilds:
+    # enable for the default branch (defaults to true)
+    master: true
+    # enable for all branches in this repo (defaults to false)
+    branches: true
+    # enable for pull requests coming from this repo (defaults to true)
+    pullRequests: true
+    # enable for pull requests coming from forks (defaults to false)
+    pullRequestsFromForks: true
+    # add a check to pull requests (defaults to true)
+    addCheck: true
+    # add a "Review in Gitpod" button as a comment to pull requests (defaults to false)
+    addComment: true
+    # add a "Review in Gitpod" button to the pull request's description (defaults to false)
+    addBadge: false

.npmrc

@@ -1 +1,2 @@
 @cahllagerfeld:registry=https://npm.pkg.github.com
+//npm.pkg.github.com/:_authToken=${GH_TOKEN}

Dockerfile

@@ -1,13 +1,14 @@
 FROM node:15 as development
 LABEL org.opencontainers.image.source https://github.com/eddiehubcommunity/api
 ARG github_token
+ENV GH_TOKEN=${github_token}
 
 WORKDIR /usr/src/app
 
+
 COPY package*.json ./
 COPY .npmrc .npmrc
 
-RUN echo "//npm.pkg.github.com/:_authToken=${github_token}" > ~/.npmrc
 RUN npm install --ignore-scripts
 RUN rm -f .npmrc
 
@@ -20,13 +21,13 @@ LABEL org.opencontainers.image.source https://github.com/eddiehubcommunity/api
 ARG github_token
 ARG NODE_ENV=production
 ENV NODE_ENV=${NODE_ENV}
+ENV GH_TOKEN=${github_token}
 
 WORKDIR /usr/src/app
 
 COPY package*.json ./
 COPY .npmrc .npmrc
 
-RUN echo "//npm.pkg.github.com/:_authToken=${github_token}" > ~/.npmrc
 RUN npm install --production --ignore-scripts
 
 COPY . .

README.md

@@ -7,6 +7,7 @@
 
 Stargate - sign up with GitHub login for [FREE on DataStax Stargate](http://links.eddiejaoude.io/t/CiEQRydj4GdT) and get a NoSQL DB up in minutes with approximately `30 million reads, 5 million writes, and 40GB of storage per month for free` (Docker container also available)
 
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/EddieHubCommunity/api)
 ## Description
 
 An API to manage our community data
@@ -29,12 +30,15 @@ $ npm install
 ```
 
 ## Running the app locally
-For connecting to Datastax Astra or a local stargate docker container the `nestjs-astra`-package is required. Its hosted in the Github-Package-Repository. For this reason you need to add the following sample to your local `.npmrc`.
+For connecting to Datastax Astra or a local stargate docker container the `nestjs-astra`-package is required. Its hosted in the Github-Package-Repository. For this reason you need to have an environment-variable called `GH_TOKEN`.
 ```
-//npm.pkg.github.com/:_authToken=<Your personal Token>
+export GH_TOKEN=<Your token>
 ```
 The Token can be generated in Github and needs the permission `package - read`. After this step you can run `npm install` as usual.
 
+When using gitpod, you can set environment-variables under the following link `https://gitpod.io/variables`. You can even scope the variable to a specific project.
+
+For connecting the API against the database you can use `docker-compose`
 ```bash
 # database
 $ docker-compose up

package-lock.json

@@ -96,4 +96,4 @@
     "coverageDirectory": "../coverage",
     "testEnvironment": "node"
   }
-}
+}