relic-query-server

App for approved users to share and view 3D models on the web (Portfolio Demonstration) - Server API

https://github.com/theportus/relic-query-server

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.6%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

App for approved users to share and view 3D models on the web (Portfolio Demonstration) - Server API

Basic Info
  • Host: GitHub
  • Owner: thePortus
  • License: mit
  • Language: JavaScript
  • Default Branch: main
  • Size: 126 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 3 years ago · Last pushed over 2 years ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

relic-query-server

App for approved users to share and view 3D models on the web (Portfolio Demonstration) - Server API

By David J. Thomas, thePort.us


Full Stack (MySQL ExpressJS Angular NodeJS) app for to share 3D models on the web. Upload is limited to only those users pre-approved by the site owner.


Installation

Current installation is on a Docker setup.

Install docker, and docker-compose locally. Then clone this repo and move inside the directory. Finally, fetch the submodule, which contains the seeder data.

sh git clone https://github.com/thePortus/relic-query-server.git cd relic-query-server git submodule update --init --recursive

Thenm, modify the following files with your desired accounts/passwords/ports

``` sh

most crucial, for setting account passwords

sudo nano /docker-compose.yml

you must change the server_name and redirect to have the url to which you are deploying

sudo nano /nginx/nginx.conf ```

Now, launch the docker containers with docker compose up -d.

The run command in our docker-compose.yml should have gotten the SSL certifictes for us already.

After docker is up... use docker exec to shell into the server container...

``` sh

run to get list of docker container names, look for server

docker ps

shell into the server container

docker exec -it SERVERCONTAINERNAME sh

run the server seeders

source migrate

exit out of container shell

exit ```

Now, set the certbot to autorenew.

sh docker compose run --rm certbot renew

Then, stop the webserver, and output the dhparam key

sh docker compose stop webserver sudo openssl dhparam -out /home/YOUR_USERNAME/icam-server/dhparam/dhparam-2048.pem 2048

Finally, modify the nginx/nginx.conf file and uncomment the lower server block. MAKE SURE to replace values with your domains. Then restart the server with docker compose restart.

If you have problems and the docker container keeps restarting, the certbot might not have run correctly. To fix this, first, bring down the container with docker compose down. Then, re-comment out the SSH lines in your nginx/nginx.conf file. Now, bring the image back up with docker compose up -d. Then run the command docker compose run --rm certbot certonly --webroot --webroot-path /var/www/html/ --email sample@your_domain --agree-tos --no-eff-email -d your_domain -d www.your_domain. Once it is complete, un-comment out the nginx/nginx.conf file and docker compose up -d to get it started.

That's it, the server should be up an running.

Owner

  • Name: David J. Thomas
  • Login: thePortus
  • Kind: user
  • Location: Illinois

Digital Scholar, Ancient Historian

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Thomas
    given-names: David
    orcid: https://orcid.org/0000-0001-5494-6297
title: "relic-query-server"
abstract: "App for approved users to share and view 3D models on the web (Portfolio Demonstration) - Server API"
version: 0.0.1
date-released: 2023-3-17
license: MIT
repository-code: "https://github.com/thePortus/relic-query-server"

GitHub Events

Total
Last Year

Dependencies

docker-compose.yml docker
  • certbot/certbot latest
  • mysql 5.7
  • nginx mainline-alpine
server/Dockerfile docker
  • node 18-alpine build
server/package-lock.json npm
  • 430 dependencies
server/package.json npm
  • @typescript-eslint/eslint-plugin ^5.30.7 development
  • @typescript-eslint/parser ^5.30.7 development
  • eslint ^8.20.0 development
  • aws-sdk ^2.1335.0
  • cors ^2.8.5
  • dotenv ^10.0.0
  • express ^4.18.1
  • express-rate-limit ^6.4.0
  • jsonwebtoken ^8.5.1
  • md5 ^2.3.0
  • multer ^1.4.5-lts.1
  • multer-s3 ^3.0.1
  • mysql2 ^2.3.3
  • sequelize ^6.29.3
  • sequelize-cli ^6.6.0
  • serve-favicon ^2.5.0
  • util ^0.12.4