Documentation

.github/workflows/main.yml

@@ -0,0 +1,53 @@
+name: CI test and build
+
+on:
+  push:
+  pull_request:
+    types: [opened]
+    branches:
+      - main
+
+# env settings for github releases
+# docker image push
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  # build and push image to github container registry
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      attestations: write
+      id-token: write
+    steps:
+      - name: Checkout repository
+        uses: actions/[email protected]
+      - name: Log in to the Container registry
+        uses: docker/[email protected]
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/[email protected]
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+      - name: Build and push Docker image
+        id: push
+        uses: docker/[email protected]
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+      # https://docs.github.com/en/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds
+      - name: Generate artifact attestation
+        uses: actions/[email protected]
+        with:
+          subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}
+          subject-digest: ${{ steps.push.outputs.digest }}
+          push-to-registry: true

DEVELOPMENT.md

@@ -0,0 +1,38 @@
+# DEVELOPMENT GUIDE
+
+## Proxy Project
+
+The proxy server queries the existing BCT database and manipulates that data to fit into Epochtalk's data models. The backend serves that manipulated data to the frontend project. This version of the project is for a read only mobile deployment of BCT.
+
+### Continued Development
+
+* Prequisites
+  * SSH tunnel to BCT database from localhost if developing locally, this is required to make the proxy queries work
+* Checkout each of the three projects and switch to the branch in parentheses
+  * `epochtalk/epochtalk` (ui-refactor-2020)
+    * There should be no modifications made to this project, it is just running to stop the frontend from breaking when hitting api routes which have not been ported to the new `epochtalk-server` yet
+  * `epochtalk/epochtalk-vue` (proxy)
+    * Changes can be made here when proxy BCT data doesn't quite fit into the current model design scheme of Epochtalk
+  * `slickage/epochtalk-server` (main)
+    * This should only be modified if there is an issue with existing proxied routes, or if there is a requirement to proxy more BCT data for the mobile read only site
+    * Key Files
+      * `lib/epochtalk_server/smf_query.ex` - used to proxy SMF data into Epochtalk format
+      * `lib/epochtalk_server_web/controller/*.ex` - to override a standard route with data queried from the proxy, the controller must be modified. See existing examples of using the plug `:check_proxy` the `post.ex` controller is a good example of this.
+      * `lib/epochtalk_server/bbc_parser.ex` - used to turn the bbcode parser into genserver process which can be deployed as a pool via `poolboy`
+      * `parsing.php` - bbcode parser
+      * `parsing_extra.php` - additional settings and functions required to run bbcode parser
+
+## Main Project
+
+The main project was initially written in Node/Angular an is in the process of being ported to Vue JS (Frontend) and Elixir (Backend).
+
+### Continued Development
+
+* Checkout each of the three projects and switch to the branch in parentheses
+  * `epochtalk/epochtalk` (ui-refactor-2020)
+    * There should be no modifications made to this project, it is just running to stop the frontend from breaking when hitting api routes which have not been ported to the new `epochtalk-server` yet.
+  * `epochtalk/epochtalk-vue` (main)
+    * Frontend changes should be made here. When new routes are ported to the new elixir server, the front end api/views must be updated as well.
+    * See `PortRoadMap.md` within this project to view a list of remaining views to be ported.
+  * `epochtalk/epochtalk-server` (main)
+    * See `PortRoadmap.md` within the `epochtalk-server` project for a list of which models and features have been ported.

Dockerfile

@@ -1,9 +1,10 @@
 # build stage
-FROM node:12-alpine as build-stage
+FROM node:16-alpine as build-stage
 ENV JQ_VERSION=1.6
 RUN wget --no-check-certificate https://github.com/stedolan/jq/releases/download/jq-${JQ_VERSION}/jq-linux64 -O /tmp/jq-linux64
 RUN cp /tmp/jq-linux64 /usr/bin/jq
 RUN chmod +x /usr/bin/jq
+RUN apk add --no-cache git
 WORKDIR /app
 COPY . .
 COPY src/docker-config.json src/config.json

PortRoadmap.md

@@ -0,0 +1,43 @@
+## Port Roadmap
+
+This document is used to track progress of porting views from the original node/angular `epochtalk/epochtalk` project to the new elixir/vue `epochtalk/epochtalk-vue`
+
+## Non Authenticated View Port Progress
+| View Name | Completed? |
+| --------- | ---------- |
+| Boards    | :white_check_mark: |
+| Threads   | :white_check_mark: |
+| Posts     | :white_check_mark: |
+| Profile   | :white_check_mark: |
+| About     | :x: |
+
+## Public Authenticated View Port Progress
+| View Name | Completed? |
+| --------- | ---------- |
+| Boards    | :white_check_mark: |
+| Threads   | :white_check_mark: |
+| Posts     | :white_check_mark: |
+| Profile   | :white_check_mark: |
+| WatchList | :construction_worker: |
+| Messages  | :construction_worker: |
+| Trust     | :white_check_mark: |
+| Trust Settings | :white_check_mark: |
+| Settings  | :white_check_mark: |
+| Invite User | :white_check_mark: |
+
+## Administrative Authenticated View Port Progress
+| View Name | Completed? |
+| --------- | ---------- |
+| General Settings | :x: |
+| Advanced Settings | :x: |
+| Legal Settings | :x: |
+| Theme Settings | :x: |
+| Board Management | :x: |
+| Users Management | :x: |
+| Roles Management | :x: |
+| Banned Addresses Management | :x: |
+| Users Moderation | :x: |
+| Posts Moderation | :x: |
+| Messages Moderation | :x: |
+| Board Bans Moderation | :x: |
+| Moderation Logs | :x: |

data/nginx-vue/conf.d/default.conf

@@ -0,0 +1,44 @@
+server {
+    listen       80;
+    server_name  localhost;
+
+    #access_log  /var/log/nginx/host.access.log  main;
+
+    location / {
+        root   /usr/share/nginx/html;
+        index  index.html index.htm;
+    }
+
+    #error_page  404              /404.html;
+
+    # redirect server error pages to the static page /50x.html
+    #
+    error_page   500 502 503 504  /50x.html;
+    error_page 404 =200 /index.html;
+    location = /50x.html {
+        root   /usr/share/nginx/html;
+    }
+
+    # proxy the PHP scripts to Apache listening on 127.0.0.1:80
+    #
+    #location ~ \.php$ {
+    #    proxy_pass   http://127.0.0.1;
+    #}
+
+    # pass the PHP scripts to FastCGI server listening on 127.0.0.1:9000
+    #
+    #location ~ \.php$ {
+    #    root           html;
+    #    fastcgi_pass   127.0.0.1:9000;
+    #    fastcgi_index  index.php;
+    #    fastcgi_param  SCRIPT_FILENAME  /scripts$fastcgi_script_name;
+    #    include        fastcgi_params;
+    #}
+
+    # deny access to .htaccess files, if Apache's document root
+    # concurs with nginx's one
+    #
+    #location ~ /\.ht {
+    #    deny  all;
+    #}
+}

docker-compose.yml

@@ -4,43 +4,7 @@ services:
     build: .
     ports:
       - "80:80"
-    links:
-      - epochtalk
-    environment:
-      BASE_URL: "http://localhost:8080"
-  epochtalk:
-    image: quay.io/epochtalk/epochtalk:ui-refactor-2020
-    ports:
-      - "8080:8080"
-      - "23958:23958"
-    depends_on:
-      - redis
-      - postgres
-      - epoch
-    links:
-      - redis
-      - postgres
     env_file:
-      - epochtalk-docker.env
-  epoch:
-    image: quay.io/epochtalk/epoch:v1.14.0
-    depends_on:
-      - postgres
-    links:
-      - postgres
-    environment:
-      MIX_ENV: prod
-      DATABASE_USER: docker
-      DATABASE_PASSWORD: docker
-      DATABASE_NAME: epochtalk
-      DATABASE_HOST: postgres
-  redis:
-    image: redis:4.0.1
-    user: redis
-  postgres:
-    image: postgres:11.1
-    environment:
-      POSTGRES_USER: docker
-      POSTGRES_PASSWORD: docker
+      - epochtalk-vue.env
     volumes:
-      - ./db:/var/lib/postgresql/data
+      - ./data/nginx-vue/conf.d:/etc/nginx/conf.d

example.env

@@ -1,2 +1,8 @@
+# When adding a new env variable,
+# make sure to add an entry to:
+# src/config.json (dev)
+# and
+# src/docker-config.json (prod)
 VUE_APP_BACKEND_URL=http://localhost:4000
 VUE_APP_OLD_BACKEND_URL=http://localhost:8080
+VUE_APP_API_KEY=ABC123

package.json

@@ -19,33 +19,34 @@
     "url": "git://github.com/epochtalk/epochtalk-vue"
   },
   "dependencies": {
-    "@fortawesome/fontawesome-free": "^5.15.1",
-    "@vueform/multiselect": "^1.2.5",
-    "axios": "^0.21.0",
-    "core-js": "^3.6.5",
-    "dayjs": "^1.9.6",
-    "emittery": "^0.10.1",
-    "jquery": "^3.6.0",
-    "nestable": "git+https://github.com/slickage/Nestable.git",
+    "@fortawesome/fontawesome-free": "^6.4.0",
+    "@vueform/multiselect": "^2.6.2",
+    "axios": "^1.4.0",
+    "core-js": "^3.32.0",
+    "dayjs": "^1.11.8",
+    "emittery": "^1.0.1",
+    "jquery": "^3.7.0",
+    "nestable": "https://github.com/epochtalk/Nestable.git",
     "normalize.css": "^8.0.1",
     "nprogress": "^0.2.0",
-    "sass": "^1.55.0",
-    "slugify": "^1.6.1",
-    "socketcluster-client": "^14.3.2",
-    "swrv": "^1.0.0-beta.5",
-    "vue": "^3.0.0",
-    "vue-router": "^4.0.6",
+    "phoenix": "^1.7.7",
+    "sass": "^1.64.1",
+    "slugify": "^1.6.6",
+    "socketcluster-client": "^17.1.1",
+    "swrv": "^1.0.3",
+    "vue": "^3.3.4",
+    "vue-router": "^4.2.2",
     "vuedraggable": "^4.1.0"
   },
   "devDependencies": {
+    "@babel/eslint-parser": "^7.21.8",
     "@vue/cli-plugin-babel": "~5.0.8",
     "@vue/cli-plugin-eslint": "~5.0.8",
     "@vue/cli-service": "~5.0.8",
-    "@vue/compiler-sfc": "^3.0.0",
-    "babel-eslint": "^10.1.0",
-    "eslint": "^7.27.0",
-    "eslint-plugin-vue": "^7.0.0-0",
-    "sass-loader": "^10"
+    "@vue/compiler-sfc": "^3.3.4",
+    "eslint": "^8.46.0",
+    "eslint-plugin-vue": "^9.14.1",
+    "sass-loader": "^13.3.1"
   },
   "eslintConfig": {
     "root": true,
@@ -57,9 +58,11 @@
       "eslint:recommended"
     ],
     "parserOptions": {
-      "parser": "babel-eslint"
+      "parser": "@babel/eslint-parser"
     },
-    "rules": {}
+    "rules": {
+      "vue/multi-word-component-names": "off"
+    }
   },
   "browserslist": [
     "> 1%",

public/index.html

@@ -5,18 +5,18 @@
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width,initial-scale=1.0">
     <link rel="icon" href="/favicon.ico">
-    <title><%= htmlWebpackPlugin.options.title %></title>
+    <title>Bitcoin Forum</title>
   </head>
   <body>
     <noscript>
-      <strong>We're sorry but <%= htmlWebpackPlugin.options.title %> doesn't work properly without JavaScript enabled. Please enable it to continue.</strong>
+      <strong>We're sorry but Bitcoin Forum doesn't work properly without JavaScript enabled. Please enable it to continue.</strong>
     </noscript>
     <div id="app"></div>
     <div id="modals"></div>
     <!-- built files will be auto injected -->
     <script id="config-remote" async>
       window.configScript = document.createElement('script')
-      window.configScript.src = '<%= process.env.VUE_APP_BACKEND_URL%>/config.js'
+      window.configScript.src = '<%= process.env.VUE_APP_BACKEND_URL || "$VUE_APP_BACKEND_URL"%>/config.js'
       window.configScript.type = 'text/javascript'
 
       // Try to append config from backend

src/App.vue

@@ -4,7 +4,7 @@
       <ProvideWebsocket>
         <ProvideBreadcrumbs>
           <div id="wrapper" :class="{ 'admin': adminMode }">
-            <Header></Header>
+            <HeaderComponent></HeaderComponent>
             <main>
               <div id="public-content">
                 <router-view />
@@ -18,7 +18,7 @@
 </template>
 
 <script>
-import Header from '@/components/layout/Header.vue'
+import HeaderComponent from './components/layout/HeaderComponent.vue'
 import ProvidePreferences from '@/composables/stores/prefs'
 import ProvideAuth from '@/composables/stores/auth'
 import ProvideWebsocket from '@/composables/services/websocket'
@@ -28,7 +28,7 @@ import { useRoute } from 'vue-router'
 
 export default {
   name: 'Epochtalk',
-  components: { Header, ProvidePreferences, ProvideWebsocket, ProvideBreadcrumbs, ProvideAuth },
+  components: { HeaderComponent, ProvidePreferences, ProvideWebsocket, ProvideBreadcrumbs, ProvideAuth },
   setup() {
     const v = reactive({ adminMode: false })
     const $route = useRoute()
@@ -106,13 +106,13 @@ main {
   #public-content {
     @include base-layout-width;
     @include grid-base-layout;
-    @include grid-columns-base;
     // margin-top: $header-bottom-margin;
     grid-template-areas:
       "header header"
       "main main"
       "sidebar sidebar";
     grid-gap: 2rem;
+    column-gap: 0;
     row-gap: 0;
     margin-bottom: 2rem;