Merge pull request #168 from intelops/add-support-for-other-git-platforms

Add Cassandra and Sqilte as data store in app,  support for multiple gitPlatform

Author: mahendraintelops

.github/workflows/core-ci.yml

@@ -115,11 +115,11 @@ jobs:
         with:
           # relative path to the place where source code with Dockerfile is located
           context: ./core
-          # Note: tags has to be all lower-case
+          # Note: tags have to be all lower-case
           tags: ${{ env.REGISTRY }}/${{ github.repository }}/core:${{ github.run_id }}
           # ${{ steps.metadata.outputs.tags }}
           labels: ${{ steps.metadata.outputs.labels }}
-          # build on feature branches, push only on main branch
+          # build on feature branches, push only on the main branch
           push: true
 #      - uses: goodwithtech/dockle-action@main
 #        with:

.gitignore

@@ -11,4 +11,6 @@
 /app/coverage
 openapitools.json
 /core/openapitools.json
-/ui/.env.kind.cluster
+/ui/.env.kind.cluster
+/app/compage-app.sqlite3
+/deploy/build/

CONTRIBUTING.md

@@ -28,14 +28,13 @@ To contribute code,
 5. Fork the project.
 6. Clone the project: `git clone https://github.com/[YOUR_USERNAME]/compage && cd compage`
 7. kindly refer compage.md file to know the structure of the project.
-8. Refer [GitHub App setup](./github-app-setup.md)
-9. The Compage has 3 servers (subprojects) which need to be started to run the compage on local
+8. The Compage has 3 servers (subprojects) which need to be started to run the compage on local
    - core (Golang), navigate to core directory and follow its [core README](./core/README.md)
-   - app (Nodejs), navigate to app directory and follow its [app README](./app/README.md)
+   - app (NodeJs), navigate to app directory and follow its [app README](./app/README.md)
    - ui (ReactJs), navigate to ui directory and follow its [ui README](./ui/README.md)
-10. Commit changes *([Please refer the commit message conventions](https://www.conventionalcommits.org/en/v1.0.0/))*
-11. Push commits.
-12. Open pull request.
+9. Commit changes *([Please refer the commit message conventions](https://www.conventionalcommits.org/en/v1.0.0/))*
+10. Push commits.
+11. Open pull request.
 
 ## Improving the Documentation
 The documentation is contained within `./docs` and made with Docusaurus. See the [Docs README](./docs/README.md) for infos about developing the docs.

README.md

@@ -164,7 +164,6 @@ Active communication channels
 
 ## Quick start
 
-- Register an app - Refer [GitHub App setup](./github-app-setup.md).
 - Follow step-by-step instructions given here [Run Compage on local](./deploy/README.md).
 
 ## License

app/Dockerfile

@@ -1,5 +1,5 @@
 # build environment
-FROM node:18.15-alpine as builder
+FROM node:18.18.0-alpine3.18 as builder
 WORKDIR /app
 COPY . .
 RUN npm install -g npm@latest && npm install --production=false && \
@@ -10,13 +10,17 @@ RUN npm install -g npm@latest && npm install --production=false && \
     npm install
 
 # production environment
-FROM node:18.15-alpine
+FROM node:18.18.0-alpine3.18
 WORKDIR /server
 RUN apk update && apk add git
 COPY --from=builder /app/dist /server/dist
 COPY --from=builder /app/node_modules /server/node_modules
 COPY --from=builder /app/protobufs /server/protobufs
-
+### Add new user
+RUN adduser -D -g '' compageuser
+RUN mkdir -p $HOME/.compage/workdir
+RUN chmod -R 777 $HOME/.compage/workdir
+USER compageuser
 ENV NODE_ENV=production
 EXPOSE 5000
 CMD [ "node", "dist/src/app.js" ]

app/README.md

@@ -1,25 +1,20 @@
 # app
-- This component integrates the GitHub Oauth2 App for authentication.
-- This also uses K8s's etcd store to persist projects and users related data.
-- It's an Express JS based REST server and gRPC client to core component.
+- This is a component that connects to different git-platforms and push-pull repositories. 
+- This also uses Cassandra or SQLite (based on configuration) databases to persist projects, git platforms, and users related details.
+- It's an Express.js based REST server and gRPC client to a core component.
+- The sqlite is used as a database for development. To use cassandra, you need to set the following environment variables in your terminal along with a `environment DB_TYPE='cassandra'`.
+```bash
+    export CASSANDRA_CONTACT_POINTS = 'localhost';
+    export CASSANDRA_LOCAL_DATA_CENTER = 'datacenter1';
+    export CASSANDRA_KEYSPACE = 'compage';
+    export CASSANDRA_USERNAME = 'cassandra';
+    export CASSANDRA_PASSWORD = 'cassandra';
+```
+- To start the cassandra server on local, you can fire command `docker-compose up -d` from the setup directory of compage/app.
 
 #### How to run this component?
 - Navigate to app directory [`cd app`] from root directory of compage
 - Fire `npm install` to install the dependencies
-- Install the CRDs for projects and users (when you are running for the first time.) by firing below commands
-    - `kubectl create ns compage`
-    - `kubectl config set-context --current --namespace=compage`
-    - `kubectl apply -f crds/project-crd.yaml`
-    - `kubectl apply -f crds/user-crd.yaml`
-- Check if you are able to list `projects` and `users`. You should see below just after you fire above commands for the first time.
-```shell
-  ❯ kubectl get projects -A
-  No resources found 
-```
-  and
-```shell
-  ❯ kubectl get users -A
-  No resources found 
-```
-- If you find some other error apart from the above one, that means the installation of CRDs didn't succeed.
-- Run `npm run dev` command to start the express-server. This command will auto-reload the changes you make to app directory.
+- Run `npm run dev` command to start the express-server. This command will auto-reload the changes you make to app directory.
+- If something goes wrong, you want to kill the process on port 5000, run the following command
+```sudo kill -9 `sudo lsof -t -i:5000```

app/crds/project-crd.yaml

@@ -44,14 +44,10 @@ deployments:
             env:
               - name: NODE_ENV
                 value: development
-              - name: GITHUB_APP_CLIENT_ID
-                value: ${GITHUB_APP_CLIENT_ID}
-              - name: GITHUB_APP_CLIENT_SECRET
-                value: ${GITHUB_APP_CLIENT_SECRET}
-              - name: GITHUB_APP_REDIRECT_URI
-                value: ${GITHUB_APP_REDIRECT_URI}
               - name: COMPAGE_CORE_URL
                 value: ${COMPAGE_CORE_URL}
+              - name: LOG_LEVEL
+                value: debug
         service:
           ports:
             - port: 5000