From 99257b583d68164a031d72197b1bf15ac96983d2 Mon Sep 17 00:00:00 2001 From: Ron <66834451+SyniRon@users.noreply.github.com> Date: Wed, 27 Nov 2024 22:27:41 -0500 Subject: [PATCH] Next.js Migration (#70) * bring in line with nextjs version * add idea to gitignore * fix up compose for live deploy * fix up compose for live deploy * post stg deploy compose fixes * remove old workflows * remove old workflows --- .github/workflows/build_check.yml | 45 - .github/workflows/client_adr_push.yml | 73 - .github/workflows/lint_format.yml | 2 +- .github/workflows/server_adr_push.yml | 55 - .gitignore | 48 +- Dockerfile | 20 - LICENSE | 674 - README.md | 220 +- client/Dockerfile | 16 - client/README.md | 7 - client/{ => app}/.dockerignore | 0 client/{ => app}/.gitignore | 2 +- client/app/adr/loading.jsx | 18 + client/app/adr/modules/AdrListEntry.jsx | 23 + client/app/adr/modules/ArrayBuilder.js | 11 + .../adr/modules/ArrayMap.jsx} | 2 +- .../adr/modules/MilpacParse.jsx} | 7 +- .../Rosterstatistics.css => app/adr/page.css} | 41 +- client/app/adr/page.jsx | 65 + client/{public => app}/favicon.ico | Bin client/{src/index.css => app/globals.css} | 23 +- client/app/layout.jsx | 20 + .../pages/NoPage.js => app/not-found.jsx} | 12 +- .../{src/pages/CavApps.css => app/page.css} | 0 client/{src/pages/Cavapps.js => app/page.jsx} | 17 +- .../reusableModules/BilletBank.jsx} | 369 +- .../app/reusableModules/getApiTimestamp.jsx | 30 + .../app/reusableModules/getCombatRoster.jsx | 25 + .../app/reusableModules/getReserveRoster.jsx | 21 + client/app/rosterstatistics/loading.jsx | 18 + .../rosterstatistics/modules/statistics.jsx} | 50 +- .../rosterstatistics/page.css} | 47 +- client/app/rosterstatistics/page.jsx | 143 + .../themes/7cav => app/theme}/adrLogo.js | 0 .../themes/7cav => app/theme}/appsLogo.js | 0 client/jsconfig.json | 7 + client/next.config.js | 4 + client/package-lock.json | 29692 ++-------------- client/package.json | 52 +- client/postcss.config.js | 6 + client/public/CavAppsLogo.svg | 119 + .../7cav => public}/hamster-hamtaro.gif | Bin client/public/index.html | 18 - client/public/manifest.json | 25 - client/public/next.svg | 1 + client/public/robots.txt | 3 - client/public/vercel.svg | 1 + client/src/errorMessage.css | 41 - client/src/errorMessage.js | 30 - client/src/index.js | 44 - client/src/modules/Generic/AdrListEntry.js | 30 - client/src/modules/Generic/ArrayBuilder.js | 12 - .../src/modules/Generic/BilletListDec2023.txt | 1329 - client/src/pages/Activedutyroster.js | 158 - client/src/pages/Layout.js | 14 - client/src/pages/Rosterstatistics.js | 266 - client/src/reportWebVitals.js | 13 - client/src/setupTests.js | 5 - client/src/style/themes/7cav/Chevron.png | Bin 304 -> 0 bytes client/src/style/themes/7cav/favicon.ico | Bin 4631 -> 0 bytes client/src/style/themes/7cav/logo.png | Bin 19559 -> 0 bytes client/src/style/themes/7cav/page-bg2.png | Bin 1528036 -> 0 bytes client/tailwind.config.js | 18 + compose.yml | 37 + config/client/deployment.yml | 70 - config/server/deployment.yml | 71 - server/package-lock.json | 796 + package.json => server/package.json | 13 +- server/server.js | 5 +- 69 files changed, 4603 insertions(+), 30381 deletions(-) delete mode 100644 .github/workflows/build_check.yml delete mode 100644 .github/workflows/client_adr_push.yml delete mode 100644 .github/workflows/server_adr_push.yml delete mode 100644 Dockerfile delete mode 100644 LICENSE delete mode 100644 client/Dockerfile delete mode 100644 client/README.md rename client/{ => app}/.dockerignore (100%) rename client/{ => app}/.gitignore (95%) create mode 100644 client/app/adr/loading.jsx create mode 100644 client/app/adr/modules/AdrListEntry.jsx create mode 100644 client/app/adr/modules/ArrayBuilder.js rename client/{src/modules/Generic/ArrayMap.js => app/adr/modules/ArrayMap.jsx} (95%) rename client/{src/modules/Generic/MilpacParse.js => app/adr/modules/MilpacParse.jsx} (97%) rename client/{src/pages/Rosterstatistics.css => app/adr/page.css} (92%) create mode 100644 client/app/adr/page.jsx rename client/{public => app}/favicon.ico (100%) rename client/{src/index.css => app/globals.css} (60%) create mode 100644 client/app/layout.jsx rename client/{src/pages/NoPage.js => app/not-found.jsx} (74%) rename client/{src/pages/CavApps.css => app/page.css} (100%) rename client/{src/pages/Cavapps.js => app/page.jsx} (55%) rename client/{src/modules/Generic/BilletBank.js => app/reusableModules/BilletBank.jsx} (74%) create mode 100644 client/app/reusableModules/getApiTimestamp.jsx create mode 100644 client/app/reusableModules/getCombatRoster.jsx create mode 100644 client/app/reusableModules/getReserveRoster.jsx create mode 100644 client/app/rosterstatistics/loading.jsx rename client/{src/modules/Generic/Statistics.js => app/rosterstatistics/modules/statistics.jsx} (82%) rename client/{src/pages/Activedutyroster.css => app/rosterstatistics/page.css} (91%) create mode 100644 client/app/rosterstatistics/page.jsx rename client/{src/style/themes/7cav => app/theme}/adrLogo.js (100%) rename client/{src/style/themes/7cav => app/theme}/appsLogo.js (100%) create mode 100644 client/jsconfig.json create mode 100644 client/next.config.js create mode 100644 client/postcss.config.js create mode 100644 client/public/CavAppsLogo.svg rename client/{src/style/themes/7cav => public}/hamster-hamtaro.gif (100%) delete mode 100644 client/public/index.html delete mode 100644 client/public/manifest.json create mode 100644 client/public/next.svg delete mode 100644 client/public/robots.txt create mode 100644 client/public/vercel.svg delete mode 100644 client/src/errorMessage.css delete mode 100644 client/src/errorMessage.js delete mode 100644 client/src/index.js delete mode 100644 client/src/modules/Generic/AdrListEntry.js delete mode 100644 client/src/modules/Generic/ArrayBuilder.js delete mode 100644 client/src/modules/Generic/BilletListDec2023.txt delete mode 100644 client/src/pages/Activedutyroster.js delete mode 100644 client/src/pages/Layout.js delete mode 100644 client/src/pages/Rosterstatistics.js delete mode 100644 client/src/reportWebVitals.js delete mode 100644 client/src/setupTests.js delete mode 100644 client/src/style/themes/7cav/Chevron.png delete mode 100644 client/src/style/themes/7cav/favicon.ico delete mode 100644 client/src/style/themes/7cav/logo.png delete mode 100644 client/src/style/themes/7cav/page-bg2.png create mode 100644 client/tailwind.config.js create mode 100644 compose.yml delete mode 100644 config/client/deployment.yml delete mode 100644 config/server/deployment.yml create mode 100644 server/package-lock.json rename package.json => server/package.json (51%) diff --git a/.github/workflows/build_check.yml b/.github/workflows/build_check.yml deleted file mode 100644 index 07267fb..0000000 --- a/.github/workflows/build_check.yml +++ /dev/null @@ -1,45 +0,0 @@ -# This is a basic workflow to help you get started with Actions - -name: BUILD_CHECK - -# Controls when the workflow will run -on: - pull_request: - branches: - - main - paths: - - ".github/workflows/client_adr_push.yml" - - "client/**" - - "config/client/**" - -# A workflow run is made up of one or more jobs that can run sequentially or in parallel -jobs: - # deployment - client_deployment: - # The type of runner that the job will run on - runs-on: ubuntu-latest - env: - REACT_APP_CLIENT_TOKEN: ${{ secrets.CLIENT_TOKEN }} - REACT_APP_COMBAT_API_URL: "https://bff.apps.7cav.us/roster/combat" - REACT_APP_RESERVE_API_URL: "https://bff.apps.7cav.us/roster/reserve" - - # Steps represent a sequence of tasks that will be executed as part of the job - steps: - # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - - name: Checkout the Repo - uses: actions/checkout@v3 - - - name: Setup node.js - uses: actions/setup-node@v3 - - - name: Install Dependancies - run: npm i - working-directory: client - - - name: Update Browserlist - run: npx browserslist@latest --update-db - working-directory: client - - - name: Build Client to Prod - run: npm run build - working-directory: client diff --git a/.github/workflows/client_adr_push.yml b/.github/workflows/client_adr_push.yml deleted file mode 100644 index 9d6260c..0000000 --- a/.github/workflows/client_adr_push.yml +++ /dev/null @@ -1,73 +0,0 @@ -# This is a basic workflow to help you get started with Actions - -name: CLIENT_ADR_PUSH - -# Controls when the workflow will run -on: - push: - branches: - - main - paths: - - ".github/workflows/client_adr_push.yml" - - "client/**" - - "config/client/**" - workflow_dispatch: - -# A workflow run is made up of one or more jobs that can run sequentially or in parallel -jobs: - # deployment - client_deployment: - # The type of runner that the job will run on - runs-on: ubuntu-latest - env: - REACT_APP_CLIENT_TOKEN: ${{ secrets.CLIENT_TOKEN }} - REACT_APP_COMBAT_API_URL: "https://bff.apps.7cav.us/roster/combat" - REACT_APP_RESERVE_API_URL: "https://bff.apps.7cav.us/roster/reserves" - REACT_APP_CACHE_TIMESTAMP_URL: "https://bff.apps.7cav.us/cache-timestamp" - - # Steps represent a sequence of tasks that will be executed as part of the job - steps: - # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - - name: Checkout the Repo - uses: actions/checkout@v3 - - - name: Setup node.js - uses: actions/setup-node@v3 - - - name: Install Dependancies - run: npm i - working-directory: client - - - name: Update Browserlist - run: npx browserslist@latest --update-db - working-directory: client - - - name: Build Client to Prod - run: npm run build - working-directory: client - - - name: Build client Image - run: docker build --file ./client/Dockerfile --tag registry.digitalocean.com/s6containers/adr_client:$(echo $GITHUB_SHA | head -c7) . - - - name: Instal doctl - uses: digitalocean/action-doctl@v2 - with: - token: ${{ secrets.DIGITALOCEAN_ACCESS_TOKEN }} - - - name: Log in to DO Container Registry - run: doctl registry login --expiry-seconds 600 - - - name: Push image to DO Container Registry - run: docker push registry.digitalocean.com/s6containers/adr_client:$(echo $GITHUB_SHA | head -c7) - - - name: Update Deployment File - run: TAG=$(echo $GITHUB_SHA | head -c7) && sed -i 's||registry.digitalocean.com/s6containers/adr_client:'${TAG}'|' $GITHUB_WORKSPACE/config/client/deployment.yml - - - name: Save DO Kubeconfig with short-lived credentials - run: doctl kubernetes cluster kubeconfig save --expiry-seconds 600 cav-kube - - - name: Deploy to DO Cluster - run: kubectl apply -f $GITHUB_WORKSPACE/config/client/deployment.yml - - - name: Verify Deployment - run: kubectl rollout status deployment/adr-client -n 7cav diff --git a/.github/workflows/lint_format.yml b/.github/workflows/lint_format.yml index 91c498d..e36bda7 100644 --- a/.github/workflows/lint_format.yml +++ b/.github/workflows/lint_format.yml @@ -21,7 +21,7 @@ jobs: - name: Checkout the Repo uses: actions/checkout@v3 - - name: Prettiier + - name: Prettier uses: creyD/prettier_action@v4.3 with: prettier_options: "--check {**/*,*}.{js,jsx,json,html,css,yml,yaml}" diff --git a/.github/workflows/server_adr_push.yml b/.github/workflows/server_adr_push.yml deleted file mode 100644 index 0e20d7f..0000000 --- a/.github/workflows/server_adr_push.yml +++ /dev/null @@ -1,55 +0,0 @@ -# This is a basic workflow to help you get started with Actions - -name: SERVER_ADR_PUSH - -# Controls when the workflow will run -on: - push: - branches: - - main - paths: - - ".github/workflows/server_adr_push.yml" - - "server/**" - - "Dockerfile" - - "package.json" - - "config/server/**" - workflow_dispatch: - -# A workflow run is made up of one or more jobs that can run sequentially or in parallel -jobs: - # deployment - server_deployment: - # The type of runner that the job will run on - runs-on: ubuntu-latest - - # Steps represent a sequence of tasks that will be executed as part of the job - steps: - # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - - name: Checkout the Repo - uses: actions/checkout@v3 - - - name: Build Server Image - run: docker build --file ./Dockerfile --tag registry.digitalocean.com/s6containers/adr_server:$(echo $GITHUB_SHA | head -c7) . - - - name: Instal doctl - uses: digitalocean/action-doctl@v2 - with: - token: ${{ secrets.DIGITALOCEAN_ACCESS_TOKEN }} - - - name: Log in to DO Container Registry - run: doctl registry login --expiry-seconds 600 - - - name: Push image to DO Container Registry - run: docker push registry.digitalocean.com/s6containers/adr_server:$(echo $GITHUB_SHA | head -c7) - - - name: Update Deployment File - run: TAG=$(echo $GITHUB_SHA | head -c7) && sed -i 's||registry.digitalocean.com/s6containers/adr_server:'${TAG}'|' $GITHUB_WORKSPACE/config/server/deployment.yml - - - name: Save DO Kubeconfig with short-lived credentials - run: doctl kubernetes cluster kubeconfig save --expiry-seconds 600 cav-kube - - - name: Deploy to DO Cluster - run: kubectl apply -f $GITHUB_WORKSPACE/config/server/deployment.yml - - - name: Verify Deployment - run: kubectl rollout status deployment/adr-server -n 7cav diff --git a/.gitignore b/.gitignore index 6f84c09..1fe6b8d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,44 @@ -node_modules/ -credentials/token.js +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +# dependencies +client/node_modules +server/node_modules +/node_modules +/.pnp +.pnp.js + +# testing +/coverage + +# next.js +/.next/ +client/.next +/out/ + +# production +/build + +# misc +.DS_Store +*.pem + +# debug +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# local env files +.env*.local + +# vercel +.vercel + +# typescript +*.tsbuildinfo +next-env.d.ts + +# Server Token server/credentials/token.js -package-lock.json -client/src/credentials/token.js -client/.env \ No newline at end of file +.env + +/.idea/ \ No newline at end of file diff --git a/Dockerfile b/Dockerfile deleted file mode 100644 index af032fa..0000000 --- a/Dockerfile +++ /dev/null @@ -1,20 +0,0 @@ -# Use an official Node.js runtime as the base image -FROM node:lts-alpine - -# Set the working directory inside the container - -COPY . /app - -WORKDIR /app - -RUN rm -rf ./client - -RUN npm install -g npm -# Install the dependencies -RUN npm install - -# Expose the port that the HTTP server will use -EXPOSE 4000 - -# Set the command to run the HTTP server when the container starts -CMD [ "node", "./server/server.js" ] diff --git a/LICENSE b/LICENSE deleted file mode 100644 index e62ec04..0000000 --- a/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ -GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/README.md b/README.md index 35c9800..45295a8 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,15 @@ -

+

## Overview + [![Server ADR Deployment](https://github.com/7Cav/adr/actions/workflows/server_adr_push.yml/badge.svg)](https://github.com/7Cav/adr/actions/workflows/server_adr_push.yml) [![Client ADR Deployment](https://github.com/7Cav/adr/actions/workflows/client_adr_push.yml/badge.svg)](https://github.com/7Cav/adr/actions/workflows/client_adr_push.yml) -The Active Duty Roster (ADR) is a Reactjs based app designed to automatically track membership of every position within the 7th Cavalry Gaming Regiment via the 7th Cavalry API. The ADR is structured as a client-server architecture and includes basic authentication for enhanced security. Though the ADR is accurate, semi-regular maintenence is needed in order to keep tracked billets up to date. +7th Cavalry Apps (CavApps) is a Nextjs based collection of tools and apps designed to aid the 7th Cavalry Gaming Regiment in its day to day functions. In its current form, CavApps currently includes the Active Duty Roster (ADR) and a small collection of Roster Statistics. Future iterations of CavApps can include a more advanced statistics tool, an AWOL tracker, and a potential migration of S1 Documents among other possible tools. CavApps is currently structured as a Frontend-Backend architecture and includes basic authentication for enhanced security. + +The live deployment can be found at https://apps.7cav.us/ and the backend at https://bff.apps.7cav.us/ + +**NOTE:** This documentation is written so that an average member of the 7th Cavalry should be able to make basic edits to CavApps. If you need help with a particular matter or believe this documentation could be improved, please message S6 Development Staff on Discord or on the Forums. ## Table of Contents @@ -15,34 +20,42 @@ The Active Duty Roster (ADR) is a Reactjs based app designed to automatically tr - [Updating the ADR](#updating-the-adr) - [Add New Billet in Existing Category](#add-new-billet-in-existing-category) - [Add New Category](#add-new-category) -- [TODO](#todo) +- [Server Deployment](#server-deployment) + - [Requirements](#requirements-1) +- [Roster Statistics](#roster-statistics) +- [Future Goals](#future-goals) ## Running Locally ### Requirements In order to run the ADR locally for development, you need the following: + - A valid [7th Cavalry Gaming](https://7cav.us/) account with member-level privileges (i.e. not a public account). -- An instance of [Node.js](https://nodejs.org/en) installed on your system. -- Your choice of IDE such as [VSCode](https://code.visualstudio.com/). +- [Node.js](https://nodejs.org/en) v16.14+ +- Your choice of IDE such as [VSCode](https://code.visualstudio.com/) or [neoVim](https://neovim.io/). #### Authorization -Before you get started with your server, you require two methods of authentication. You require both an API token from 7th Cavalry Gaming and a local clientside token. +Before you get started on CavApps, the dependancies need to be installed on your end. + +- Open a terminal/cmd prompt, navigate to the CavApps project folder and execute the command `npm install`. + +Next, you require two methods of authentication. You require both an API token from 7th Cavalry Gaming and a local clientside token. To get and apply your API token do the following steps: 1. Log into your 7th Cavalry Gaming account. 2. Navigate to your [Connected Accounts](https://7cav.us/account/connected-accounts/) and select the "view account" button for auth.7cav.us 3. Once you have logged into keycloak, copy the provided API token into your clipboard. -4. Open the adr project folder and navigate to `adr/server/credentials`. Inside should be a file named `example_token.js`. +4. Open the CavApps project folder and navigate to `cavapps/server/credentials`. Inside should be a file named `example_token.js`. 5. Make a duplicate `example_token.js` and rename it to `token.js`. 6. Inside the new `token.js` file, paste your API token in the `API_TOKEN` constant and save the file. To make a clientside token, do the following: -1. Open the adr project folder and navigate to `/client`. -2. Inside the Client folder create a nameless `.env` file. When opened, the directory should be `adr/client/.env` +1. Open the root CavApps project folder. +2. Inside the root folder create a nameless `.env` file. When opened, the directory should be `cavapps/.env` 3. Paste the following code into the `.env` file. ```dotenv @@ -51,32 +64,34 @@ REACT_APP_COMBAT_API_URL=http://localhost:4000/roster/combat REACT_APP_RESERVE_API_URL=http://localhost:4000/roster/reserves REACT_APP_CACHE_TIMESTAMP_URL=http://localhost:4000/cache-timestamp ``` + 4. Replace the `REACT_APP_CLIENT_TOKEN` constant with a password of your choice and save. -5. Navigate to `adr/server/credentials/token.js` and ensure the `CLIENT_TOKEN` constant matches the same constant in the previous `.env` file and save. +5. Navigate to `cavapps/server/credentials/token.js` and ensure the `CLIENT_TOKEN` constant matches the same constant in the previous `.env` file and save. ### Getting Started -Before initializing the server, the dependancies for the ADR need to be installed on your end. - -- Open a terminal/cmd prompt and navigate to the adr project folder and execute the command `npm install`. -- Once the install finishes, navigate to `adr/client` and execute the previous command. - You should now be ready to run the Server and the Client. -- Open two terminals. On the first terminal navigate to `adr/server` and enter the command `node server.js`. You should see that the server is listening on localhost:4000 and can be additionally verified by visiting localhost:4000 on your browser. -- On the second terminal, navigate to `adr/client/src` and run the command `npm start`. Once the clientside is running, you should be automatically redirected to localhost:3000 on your browser. A sucessful response is when the ADR is completely filled. +- Open two terminals. On the first terminal navigate to `cavapps/server` and enter the command `node server.js`. You should see that the server is listening on localhost:4000 and can be additionally verified by visiting localhost:4000 on your browser. +- On the second terminal, navigate to `cavapps/client/app` and run the command `npm run dev`. Once the clientside is running, open your browser and go to http://localhost:3000 . You should see the CavApps index page on your screen. + +You are now good to go! `cavapps/client/app` is the root folder in which CavApps is operated. Closing the terminals will close the servers. Happy Coding! -You are now good to go! `adr/client/src/app.js` is the primary file in which everything on the clientside is ran. Closing the terminals will close the servers. Happy Coding! +For further documentation on NextJS apps, visit https://nextjs.org/docs ## Updating the ADR +Since the ADR sources its data from the 7th Cavalry API and compares the API against a predefined billet list, the ADR is not aware when new billets are created or when older billets are moved. + +For example, if a new company in 2-7 is created, the list the ADR compares against needs to be updated in order to display the membership of the new company. + ### Add New Billet in Existing Category -To add a new billet to an existing category, you need to update the `BilletBank.js` file located in `client/src/modules/Generic`. +To add a new billet to an existing category, you need to update the `BilletBank.jsx` file located in `cavapps/client/app/reusableModules`. #### Step-by-Step Instructions -1. Open `BilletBank.js`. +1. Open `BilletBank.jsx`. 2. Locate the array that corresponds to the category where you wish to add the new billet. 3. Append the new billet ID to this array. @@ -85,64 +100,163 @@ To add a new billet to an existing category, you need to update the `BilletBank. Suppose you want to add a new billet with an ID of `28` to the "Information Management Office Command" category. Update `imoCommand` as follows: ##### Before: + ```javascript -const imoCommand = ['5','9']; +const imoCommand = ["5", "9"]; ``` + ##### After: + ```javascript -const imoCommand = ['5','9','28']; +const imoCommand = ["5", "9", "28"]; ``` --- ### Add New Category -To introduce a new category, both `BilletBank.js` and `App.js` need to be updated. +To introduce a new category, both `BilletBank.jsx` and `page.jsx` located in `cavapps/client/app/adr/page.jsx` need to be updated. #### Step-by-Step Instructions -1. **In `BilletBank.js`:** - - Add a new array for the subcategory and populate it with billet IDs. - - Add this new subcategory to the `billetBank` constant. +1. **In `BilletBank.jsx`:** + + - Add a new array for each subcategory and populate it with the requred billet IDs. + - Add a new object for the new category and append the subcategories as well as their titles to the new object. additionally, add a `collapsibleTitle` with the name of the new category into the object. + - Add the new object to the billetbank object at the bottom of the file -2. **In `App.js`:** - - Create a new `
` with the class `DepartmentContainer`. - - Inside this `
`, add a `Collapsible` component for the new category and subcategory. +2. **In `adr/page.jsx`:** + - Create a new `AdrListEntry` with the bBGroup value set to a string containing title of the new Object #### Example: -To add a new major category called "test" with a subcategory "subTest," do the following: +You have been assigned the task of creating an entry in the ADR for 3rd Battalion. It has 3 companies, Alpha Bravo and Charlie. Each have their own designated billet ID's. (in a live setting, each company can have strings that are dozens of entries each in length) -**In `BilletBank.js`:** -```javascript -const subTest = ['1', '2', '3']; +**In `BilletBank.jsx`:** + +```jsx +//3-7 + +const threeSevenCommand = ['1', '2', '3'] //placeholder values +const alpha3 = ['4','5','6'] +const bravo3 = ['7','8','9'] +const charlie3 = ['10','11','12'] + +const threeSeven = { + positionIds: [threeSevenCommand, alpha3, bravo3, charlie3], + positionTitles: [ + "3-7 Headquarters", + "Alpha Company", + "Bravo Company", + "Charlie Company", + ], + collapsibleTitle: "Third Battalion", +}; + +... -const billetBank = { - regiCommand, - oneSevenCommand, - subTest, +const billetBankObject = { + regi: regi, + oneSeven: oneSeven, + twoSeven: twoSeven, + threeSeven: threeSeven, + ... }; ``` -**In `App.js`:** -```javascript -
- -
- -
- -
+**In `adr/page.jsx`:** + +```jsx +// important: make sure the bBGroup string matches the object name in the billetBank section +... + + + +... ``` -> Note: Ensure that you add these elements in the proper locations in `App.js` to maintain the formatting. +> Note: Ensure that you add these elements in the proper locations in `page.jsx` to maintain the formatting. + +## Server Deployment + +**NOTE:** If you are making changes to CavApps and want said changes put on the live version, submit a pull request. This section is intended for S6 Staff for deployment testing purposes. + +### Requirements + +In order to deploy CavApps on a server, you need the following: + +- A linux (preferably ubuntu) based server with the following: + - Access via SSH + - Sudo level permissions + - Minimum 2GB RAM +- Alongside the following packages: + + - [Docker Engine](https://docs.docker.com/engine/install/ubuntu/) + - nodejs + - npm + - git + + ``` + sudo apt install git npm nodejs + ``` + +- A 7th Cavalry API token (see [Authorization](#authorization)) --- -## TODO +### Deployment + +Once the required packages are installed, clone the repo + +``` +git clone https://github.com/Vercin-G/CavApps-Test +``` + +First, install prerequisites: + +In `CavApps-Test/server/`: + +``` +npm install +``` + +In `CavApps-Test/client/`: + +``` +npm install +``` + +Next, cd into `CavApps-Test/server/credentials` and make the token.js file as described in [Authorization](#authorization). + +cd into `CavApps-Test/client` and create a .env file with the contents as shown: + +```dotenv +REACT_APP_CLIENT_TOKEN ="XXXXXX" +REACT_APP_COMBAT_API_URL=http://server:4000/roster/combat +REACT_APP_RESERVE_API_URL=http://server:4000/roster/reserves +REACT_APP_CACHE_TIMESTAMP_URL=http://server:4000/cache-timestamp +``` + +**IMPORTANT:** be sure that the urls link to http://server:4000 and **NOT** http://localhost:4000 as you would in a dev setting. If this is not done, docker will not recognize the back and front ends properly. + +Return to `CavApps-Test/` and enter: + +``` +docker compose up +``` + +And you should be good! Simply navigate to your server in your browser and the index page should show. The server side should be accessable via port 4000. + +**NOTE:** On slower servers, the generation of nextjs static pages may cause a hang. This is normal. Give it a few seconds. + +## Roster Statistics + +The Roster Statistics section is currently pending rewrite to include more information. Stay Tuned! + +## Future Goals + +CavApps has several goals in mind for the future. Here are some examples. -- [ ] Redo whole tutorial section -- [ ] Change cache warning on client to display time since cache refresh -- [ ] Investigate the feasibility of sorting by rank after billet sorting (Subsorting? Consider using QuickSort) -- [x] Add graphical data visualization -- [ ] Code Refactorizing \ No newline at end of file +- Roster Statistics which draw from a 7th Cavalry Operated database. Providing historical numbers on top of current figures +- Implementation of an AWOL tracker +- Implementation of keycloak systems to allow for the operation of internal documents. E.g. moving S1 spreadsheets into internal tools which are authenticated by keycloak. diff --git a/client/Dockerfile b/client/Dockerfile deleted file mode 100644 index 52b0597..0000000 --- a/client/Dockerfile +++ /dev/null @@ -1,16 +0,0 @@ -# Use an official Node.js runtime as the base image -FROM node:lts-alpine - -COPY . /app -# Install the dependencies -WORKDIR /app/client - -RUN npm install - -RUN npm install -g http-server - -# Expose the port that the HTTP server will use -EXPOSE 8080 - -# Set the command to run the HTTP server when the container starts -CMD [ "http-server", "build", "-P", "http://localhost:8080?/" ] diff --git a/client/README.md b/client/README.md deleted file mode 100644 index 526a69e..0000000 --- a/client/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Client Readme -### To build: -`npm install` - -`npm run build` - -`serve -s build` diff --git a/client/.dockerignore b/client/app/.dockerignore similarity index 100% rename from client/.dockerignore rename to client/app/.dockerignore diff --git a/client/.gitignore b/client/app/.gitignore similarity index 95% rename from client/.gitignore rename to client/app/.gitignore index 7f70aa0..0419e04 100644 --- a/client/.gitignore +++ b/client/app/.gitignore @@ -23,4 +23,4 @@ client/.env npm-debug.log* yarn-debug.log* -yarn-error.log* +yarn-error.log* \ No newline at end of file diff --git a/client/app/adr/loading.jsx b/client/app/adr/loading.jsx new file mode 100644 index 0000000..1da2465 --- /dev/null +++ b/client/app/adr/loading.jsx @@ -0,0 +1,18 @@ +import "./page.css"; + +export default function Loading() { + return ( +
+
+
+ {/*This gif is about 150kb. Kinda big, relatively speaking. An Svg may be desired in the furture */} + Loading +
+
Loading...
+
+ ); +} diff --git a/client/app/adr/modules/AdrListEntry.jsx b/client/app/adr/modules/AdrListEntry.jsx new file mode 100644 index 0000000..a979b2a --- /dev/null +++ b/client/app/adr/modules/AdrListEntry.jsx @@ -0,0 +1,23 @@ +import React from "react"; +import MilpacParse from "./MilpacParse"; +import lists from "../../reusableModules/BilletBank"; + +function AdrListEntry(props) { + let billetBankObject = lists.billetBankObject; + let selector = props.bBGroup; + + return ( +
+
{billetBankObject[selector].collapsibleTitle}
+
+ +
+
+ ); +} + +export default AdrListEntry; diff --git a/client/app/adr/modules/ArrayBuilder.js b/client/app/adr/modules/ArrayBuilder.js new file mode 100644 index 0000000..094b05a --- /dev/null +++ b/client/app/adr/modules/ArrayBuilder.js @@ -0,0 +1,11 @@ +//This is included as a dev tool to generate bulk billet list entries in sequential order. run this outside of cavApps. +let countString = ""; +let i = 629; +let stopper = 644; + +do { + countString = `${countString},'${i}'`; + i++; +} while (i <= stopper); + +console.log(countString); diff --git a/client/src/modules/Generic/ArrayMap.js b/client/app/adr/modules/ArrayMap.jsx similarity index 95% rename from client/src/modules/Generic/ArrayMap.js rename to client/app/adr/modules/ArrayMap.jsx index 4fa3ece..8a24947 100644 --- a/client/src/modules/Generic/ArrayMap.js +++ b/client/app/adr/modules/ArrayMap.jsx @@ -28,7 +28,7 @@ function ArrayMap(props) { {item.fullName} - {item.position.positionTitle} + {item.position.positionTitle} ))} diff --git a/client/src/modules/Generic/MilpacParse.js b/client/app/adr/modules/MilpacParse.jsx similarity index 97% rename from client/src/modules/Generic/MilpacParse.js rename to client/app/adr/modules/MilpacParse.jsx index 6257938..a7526be 100644 --- a/client/src/modules/Generic/MilpacParse.js +++ b/client/app/adr/modules/MilpacParse.jsx @@ -1,5 +1,5 @@ import React from "react"; -import ArrayMap from "./ArrayMap.js"; +import ArrayMap from "./ArrayMap"; /*Milpac Parse is used to compare the API response (milpacArray) against desired position ID's (billetBankObject). If for example, a person is a Milpacs Clerk and billetBankObject is set to check for Milpacs Clerks, Milpac Parse will search for matching entries within the API resonse. If there is someone that matches, they are pushed to an output array. (returnArray) @@ -10,9 +10,8 @@ function MilpacParse(props) { const billetBankObject = props.billetBankObject; let milpacArray = props.milpacArray; - /*Currently broken. Sypolt, pls fix. - const uniqueNamesSet = new Set(); - */ + //Currently broken. Sypolt, pls fix. + //const uniqueNamesSet = new Set(); let returnArray = Array(billetBankObject.length) .fill() diff --git a/client/src/pages/Rosterstatistics.css b/client/app/adr/page.css similarity index 92% rename from client/src/pages/Rosterstatistics.css rename to client/app/adr/page.css index a5c58d8..1ae39a9 100644 --- a/client/src/pages/Rosterstatistics.css +++ b/client/app/adr/page.css @@ -36,9 +36,10 @@ .loading-container { display: flex; justify-content: center; - align-items: flex-start; + align-items: center; height: 100%; - min-height: 100vh; + min-height: 60vh; + flex-direction: column; } .gif-spinner-wrapper { @@ -49,24 +50,32 @@ border: 0.5em solid #f3f3f3; border-top: 0.5em solid #ebc729; border-radius: 50%; - width: 8em; + width: 11em; /* Make this larger than the GIF */ - height: 8em; + height: 11em; /* Make this larger than the GIF */ animation: spin 2s linear infinite; position: absolute; - top: 50%; - left: 50%; + top: 30%; + left: 30%; z-index: 1; margin: -4em 0 0 -4.5em; /* Half of width and height */ } .p-loading-png { - width: 6em; - height: 6em; + width: 8em; + height: 8em; position: relative; z-index: 2; + transform: translatex(-7%); +} + +.loading-subtitle { + color: #f1f1f1; + font-size: x-large; + font-weight: bold; + padding: 1em; } @keyframes spin { @@ -171,10 +180,10 @@ padding-bottom: 15px; } -.Title:hover { +/*.Title:hover { text-decoration: none; cursor: pointer; -} +} */ .HeaderContainer { display: flex; @@ -203,23 +212,13 @@ width: 50%; } -a { - color: #ebc729; - text-decoration: none; -} - -a:hover { - color: #ebc729; - text-decoration: underline; -} - .Collapsible__trigger { display: block; position: relative; } .Collapsible__trigger:after { - content: url("../style/themes/7cav/Chevron.png"); + content: none; position: absolute; right: 0px; top: 0px; diff --git a/client/app/adr/page.jsx b/client/app/adr/page.jsx new file mode 100644 index 0000000..a84f245 --- /dev/null +++ b/client/app/adr/page.jsx @@ -0,0 +1,65 @@ +import Link from "next/link"; +import GetCombatRoster from "../reusableModules/getCombatRoster"; +import GetReserveRoster from "../reusableModules/getReserveRoster"; +import GetApiTimestamp from "../reusableModules/getApiTimestamp"; +import AdrListEntry from "./modules/AdrListEntry"; +import Logo from "../theme/adrLogo"; +import "./page.css"; +import "../globals.css"; + +export const metadata = { + title: "Active Duty Roster", +}; + +// look into moving this into the API calls +let milpacArray = []; + +milpacArray.push({ + combat: GetCombatRoster, + reserve: GetReserveRoster, +}); + +export default async function ActiveDutyRoster() { + return ( +
+
+
+ +
+
+
+ {/* note: bBGroup = Billet Bank Group */} + + + + + + + + +
+
+ ); +} diff --git a/client/public/favicon.ico b/client/app/favicon.ico similarity index 100% rename from client/public/favicon.ico rename to client/app/favicon.ico diff --git a/client/src/index.css b/client/app/globals.css similarity index 60% rename from client/src/index.css rename to client/app/globals.css index 969b82d..8faaa8b 100644 --- a/client/src/index.css +++ b/client/app/globals.css @@ -1,17 +1,30 @@ -body { +@tailwind base; +@tailwind components; +@tailwind utilities; + +/* heeeeyy this supports tailwind! */ + +:root { + background-color: #111111; margin: 0; font-family: "Roboto", -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, "Noto Sans", sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji"; - font-size: 13px; + font-weight: 400; + font-size: 13px; line-height: 1.5; color: #a1a1a1; background-color: #111111; align-content: space-evenly; } -code { - font-family: source-code-pro, Menlo, Monaco, Consolas, "Courier New", - monospace; +a { + color: #ebc729; + text-decoration: none; +} + +a:hover { + color: #ebc729; + text-decoration: underline; } diff --git a/client/app/layout.jsx b/client/app/layout.jsx new file mode 100644 index 0000000..46b397a --- /dev/null +++ b/client/app/layout.jsx @@ -0,0 +1,20 @@ +import "./globals.css"; + +export const metadata = { + title: "7th Cavalry Apps", + description: "NextJS based apps for 7th Cavalry Gaming", + robots: { + index: false, + }, +}; + +export default function RootLayout({ children }) { + return ( + + + {children} + + + ); +} diff --git a/client/src/pages/NoPage.js b/client/app/not-found.jsx similarity index 74% rename from client/src/pages/NoPage.js rename to client/app/not-found.jsx index 8531221..720e5ba 100644 --- a/client/src/pages/NoPage.js +++ b/client/app/not-found.jsx @@ -1,13 +1,15 @@ -import "../index.css"; +export const metadata = { + title: "404 Error", +}; -const NoPage = () => { +export default function Error404() { return (

404 Error

Oh no! you have encountered a page that does not exist!

If you believe this is in error, please submit a{" "} - ticket to S6. + Ticket to S6. Otherwise, please enjoy this sick music!