Release/2.0.0

.dockerignore

@@ -0,0 +1,2 @@
+**/node_modules
+**/dist

.github/workflows/deploy.yml

@@ -3,23 +3,61 @@ name: Deploy
 on:
   push:
     branches:
-      - main
+      - release/2.0.0
 
 jobs:
-  # test-angular-build:
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - uses: actions/checkout@v2
-  #     - run: cd angular-cards
-  #     - run: npm i 
-  #     - run: npm run build
   build:
     runs-on: ubuntu-latest
-    # needs: test-angular-build
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          push: true
+          tags: ${{ secrets.DOCKER_USERNAME }}/cards:latest
+          platforms: linux/arm64 # This is added for building image for arm64 architecture
+          build-args: |
+            DB_URL: ${{ secrets.DB_URL }}
+            JWT_SECRET: ${{ secrets.JWT_SECRET }}
+            FIREBASE_TYPE: ${{ secrets.FIREBASE_TYPE }}
+            FIREBASE_PROJECT_ID: ${{ secrets.FIREBASE_PROJECT_ID }}
+            PRIVATE_KEY_ID: ${{ secrets.PRIVATE_KEY_ID }}
+            PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
+            CLIENT_EMAIL: ${{ secrets.CLIENT_EMAIL }}
+            CLIENT_ID: ${{ secrets.CLIENT_ID }}
+            AUTH_URI: ${{ secrets.AUTH_URI }}
+            TOKEN_URI: ${{ secrets.TOKEN_URI }}
+            AUTH_PROVIDER_X509_CERT_URL: ${{ secrets.AUTH_PROVIDER_X509_CERT_URL }}
+            CLIENT_X509_CERT_URL: ${{ secrets.CLIENT_X509_CERT_URL }}
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
     steps:
-      - uses: actions/checkout@v2
-      - uses: akhileshns/heroku-deploy@v3.12.12 # This is the action
+      - name: Checkout codebase
+        uses: actions/checkout@v2
+
+      - name: Deploy
+        uses: kitconcept/docker-stack-deploy@v1.0.1
         with:
-          heroku_api_key: ${{secrets.HEROKU_API_KEY}}
-          heroku_app_name: ${{secrets.APP_NAME_HEROKU}}
-          heroku_email: "jungerjunge2@gmail.com"
+          registry: "docker.io"
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+          remote_host: ${{ secrets.REMOTE_HOST }}
+          remote_user: ${{ secrets.REMOTE_USER }}
+          remote_private_key: ${{ secrets.REMOTE_PRIVATE_KEY }}
+          stack_file: "/home/ubuntu/StudyGrow/Cards/stack.yml"
+          stack_name: "cards"

.gitignore

@@ -1,4 +1,12 @@
-/node_modules
-.env
 .DS_Store
-.vscode
+.vscode
+backend/firebase-admin.json
+node_modules
+angular-cards/.angular/cache
+angular-cards/dist
+.env
+backend/src/schema.graphql
+backend/package-lock.json
+backend/yarn.lock
+
+.vscode/launch.json

Dockerfile

@@ -0,0 +1,99 @@
+# Building layer
+FROM node:16-alpine as build
+
+# Add these lines at the top of your Dockerfile
+ARG DB_URL
+
+ARG JWT_SECRET
+
+ARG FIREBASE_TYPE
+ARG FIREBASE_PROJECT_ID
+ARG PRIVATE_KEY_ID
+ARG PRIVATE_KEY
+ARG CLIENT_EMAIL
+ARG CLIENT_ID
+ARG AUTH_URI
+ARG TOKEN_URI
+ARG AUTH_PROVIDER_X509_CERT_URL
+ARG CLIENT_X509_CERT_URL
+
+# And then use them like this
+ENV DB_URL=${DB_URL}
+
+ENV JWT_SECRET=${JWT_SECRET}
+
+ENV FIREBASE_TYPE=${FIREBASE_TYPE}
+ENV FIREBASE_PROJECT_ID=${FIREBASE_PROJECT_ID}
+ENV PRIVATE_KEY_ID=${PRIVATE_KEY_ID}
+ENV PRIVATE_KEY=${PRIVATE_KEY}
+ENV CLIENT_EMAIL=${CLIENT_EMAIL}
+ENV CLIENT_ID=${CLIENT_ID}
+ENV AUTH_URI=${AUTH_URI}
+ENV TOKEN_URI=${TOKEN_URI}
+ENV AUTH_PROVIDER_X509_CERT_URL=${AUTH_PROVIDER_X509_CERT_URL}
+ENV CLIENT_X509_CERT_URL=${CLIENT_X509_CERT_URL}
+
+
+WORKDIR /app
+
+COPY . .
+
+# _________________________________________________________ Backend _________________________________________________________
+WORKDIR /app/backend
+
+RUN npm i --force
+
+RUN npm run build
+
+# _________________________________________________________ Frontend _________________________________________________________
+
+WORKDIR /app/frontend
+
+RUN npm i --force
+
+RUN npm run build:prod
+
+# _________________________________________________________ Step 2: Production _________________________________________________________
+# Runtime (production) layer
+FROM node:16-alpine as production
+
+# install dos2unix (for docker-entrypoint.sh)
+RUN apk add --no-cache dos2unix
+
+# ___________________________________________________________ Backend _____________________________________________________________
+
+WORKDIR /app/backend
+
+# Copy backend files
+COPY ./backend .
+
+# replace localhost with db  (docker-compose service name for db container) Note: this might also replace localhost in other places in the .env file
+# RUN sed -i 's/localhost/db/g' .env
+
+# Install runtime dependecies (without dev/test dependecies)
+RUN npm i --only=production --force
+
+# Copy backend build
+COPY --from=build /app/backend/dist/ ./dist/
+
+# ___________________________________________________________ Frontend _____________________________________________________________
+# Frontend served under /app/backend/frontend/dist/frontend/*
+RUN mkdir -p /app/backend/frontend
+
+# Copy frontend build files
+# Note that they will be 
+COPY --from=build /app/frontend ./frontend/
+
+# ___________________________________________________________ Step 3: Entrypoint _________________________________________________________
+
+WORKDIR /app
+
+COPY ./docker-entrypoint.sh /app
+
+RUN dos2unix /app/docker-entrypoint.sh
+RUN chmod +x /app/docker-entrypoint.sh
+
+# Expose application port
+EXPOSE 4444
+
+ENTRYPOINT [ "/app/docker-entrypoint.sh" ]

README.md

@@ -1,79 +1,129 @@
 # Cards Project
 
-This project provides the code for frontend and backend of our cards website currently hosted on <https://studygrow-cards.herokuapp.com/>
+This project provides the code for frontend and backend of our cards website currently hosted on <https://cards.leier.lu/>
 
-## Getting Started
-
-To test this project locally you should clone this repository.
-
-### Prerequisites
+## Prerequisites
 
 To run this project you need to have the Node Package Manager installed, which can be downloaded here: <https://www.npmjs.com/get-npm/>
 
-Additionally, following environment variables should be present:  
-PORT=  
-APP_AUTH_SECRET=  
-APP_AUTH_GOOGLE_CLIENTID=  
-APP_AUTH_GOOGLE_SECRET=  
-APP_AUTH_GOOGLE_REDIRECT_URI=  
-MONGO_URL_PRODUCTION=  
-MONGO_URL_TEST=  
-SECRET=  
-AUTH_TOKEN_EXPIRATION=  
-REFRESH_TOKEN_EXPIRATION=  
+### Backend
 
-### Installing
-
-Using the command line navigate to the projects folder and type in the following command:
+Using the command line navigate to the `./backend` folder and run:
 
 ```shell
 npm install
 ```
 
-npm will install all the dependencies for you. After that use the following command to start the server:
+Additionally, some environment variables should be contained in the `backend/.env` file. Here is an example with some default values:
+
+```.env
+DB_USER=postgres
+DB_PASSWORD=mysecretpassword
+DB_PORT=5432
+DB_HOST=localhost:${DB_PORT}
+DB_NAME=studycards
+DB_SCHEMA=studycards
+# DB_URL=postgresql://${DB_USER}:${DB_PASSWORD}@${DB_HOST}/${DB_NAME}?schema=${DB_SCHEMA}&sslmode=prefer
+DB_URL=postgresql://postgres:mysecretpassword@localhost:5432/studycards?schema=studycards&sslmode=prefer
+JWT_SECRET=myJWTsecret
+PORT=4444
+HOST=localhost
+
+# Firebase config
+FIREBASE_TYPE=service_account
+FIREBASE_PROJECT_ID=
+PRIVATE_KEY_ID=
+PRIVATE_KEY=
+CLIENT_EMAIL=
+CLIENT_ID=
+AUTH_URI=
+TOKEN_URI=
+AUTH_PROVIDER_X509_CERT_URL=
+CLIENT_X509_CERT_URL=
+```
 
 ```shell
-npm run watch
+docker run --name some-postgres -p 5432:5432 -e POSTGRES_PASSWORD=mysecretpassword -e POSTGRES_DB=studycards -d postgres
 ```
 
-The server will tell you on which port it will be running in the console (80 by default). Navigate to `http://localhost:port`, where port is the port provdided by the server.
+```shell
+npx prisma db push
+```
 
-## Modifiying the frontend
+```shell
+npx prisma generate
+```
 
-The frontend is built using Angular. The Angular project folder is located in angular-cards. Download and install Angular with:
+If you want to have some sample data, you can run
+
+```shell
+npx prisma db seed
+```
+
+### Frontend
+
+Download and install Angular with:
 
 ```shell
 npm install -g @angular/cli
 ```
 
-Then navigate to the angular-cards folder and start the Angular Dev Server with the following command:
+Navigate to `./frontend`. Run:
+
+```shell
+npm install
+```
+
+## Starting the backend
+
+The database is started using the following command:
+
+```bash
+docker run --name some-postgres -p 5432:5432 -e POSTGRES_PASSWORD=mysecretpassword -e POSTGRES_DB=studycards -d postgres
+```
+
+After that use the following command to start the server:
 
 ```shell
-ng serve --proxy-config proxy.conf.json --open
+npm run start
 ```
 
-We use proxy config to bypass CORS problem, caused by angular, when communicating with our server.\
+A graphql playground is available at `localhost:4444/graphql`
+
+## Starting the frontend
+
+Navigate to the frontend folder and start the Angular Dev Server with the following command:
+
+```shell
+npm run start
+```
+
+We use proxy config to bypass CORS problem, caused by angular, when communicating with our server.
+
+## Building for production
+
 After you are done modifying the frontend you can use the following command to build your project:
 
 ```shell
-ng build
+npm run build
 ```
 
 After the process has finished you can stop the Angular Dev Server and navigate to `http://localhost:port`, where port is the port provdided by the server.
 
 ## Built With
 
-- [MongoDB](https://www.mongodb.com/) - Database
-- [Express](https://expressjs.com/) - Middleware for handling HTTP requests
+- [PostgreSQL](https://www.postgresql.org/) - Database
+- [NestJS](https://expressjs.com/) - Backend
+- [Prisma](https://www.prisma.io/) - database toolkit
+- [GraphQL](https://graphql.org/) query language
 - [Angular](https://angular.io/) - Frontend
-- [NodeJs](https://nodejs.org/) - Backend Server
 - [Passport](http://www.passportjs.org/) - Middleware for Authentication
 - and much more
 
 ## Authors
 
-- **Erdzan Rastoder** - _Original idea, Initial work_ - [Github](https://github.com/orgs/StudyGrow/people/erdzan12)
-- **Ben Lakhoune** - _Initial work_ - [Github](https://github.com/lakhoune) - [Website](http://lakhoune.com)
+- **Erdzan Rastoder** - _Original idea, Initial work_, _Maintainer_ - [Github](https://github.com/orgs/StudyGrow/people/erdzan12)
+- **Ben Lakhoune** - _Initial work_, _Maintainer_ - [Github](https://github.com/lakhoune) - [Website](http://lakhoune.com)
 
 ## License