Refactor — Renamed “client” & “server” → “frontend” & “backend”

Author: barrowclift

.gitignore

@@ -58,10 +58,9 @@ typings/
 .env
 
 # Ignore record image cache
-/client/static/images/records/record*
-/client/static/images/books/book*
-/client/static/images/board-games/boardgame*
-/server/config.json
-/replacement-art
+/frontend/static/images/records/record*
+/frontend/static/images/books/book*
+/frontend/static/images/board-games/boardgame*
+/backend/config.json
 /fix
 package-lock.json

INSTALL.md

@@ -21,8 +21,8 @@ Since this is a development environment, there's no need to setup Nginx, Shelf c
 * If you don't already have `pm2` for node process management installed, do so with `npm install pm2 -g`
 * (Optional) Should you wish Shelf to automatically start on startup, see [this short guide](http://pm2.keymetrics.io/docs/usage/startup/) or execute `pm2 startup` to let `pm2` handle the settings for you.
 * Shelf uses MongoDB to manage its data. When starting the MongoDB server, it expects permissions to create a DB at `/var/lib/mongo`. If this location is not desired or if you have a MongoDB server already running for other projects, update the `MONGO_DB` variable in `admin/init.sh` to your desired path.
-* Edit `server/config.json` with your Discogs, Goodreads, and/or BoardGameGeek information. Shelf uses these services to display your library. See the ["Setup"](https://github.com/barrowclift/shelf/blob/master/README.md#setup) section of the [README](https://github.com/barrowclift/shelf/blob/master/README.md) for more information.
-* Finally, continue editing `server/config.json`, replacing all instances of `$PLACEHOLDER` with the appropriate information
+* Edit `backend/config.json` with your Discogs, Goodreads, and/or BoardGameGeek information. Shelf uses these services to display your library. See the ["Setup"](https://github.com/barrowclift/shelf/blob/master/README.md#setup) section of the [README](https://github.com/barrowclift/shelf/blob/master/README.md) for more information.
+* Finally, continue editing `backend/config.json`, replacing all instances of `$PLACEHOLDER` with the appropriate information
 
 To spin up Shelf, execute `./start.sh`. Be sure to check the `logs/` directory to see if there are any errors.
 
@@ -74,8 +74,8 @@ Additionally, when using a reverse proxy with Node, Nginx requires SELinux to be
 * Clone the repository (`git clone git@github.com:barrowclift/shelf.git`)
 * In the cloned repo, `npm install`
 * Shelf uses MongoDB to manage its data. When starting the MongoDB server, it expects permissions to create a DB at `/var/lib/mongo`. If this location is not desired or if you have a MongoDB server already running for other projects, update the `MONGO_DB` variable in `admin/init.sh` to your desired path.
-* Edit `server/config.json` with your Discogs information. To generate a Discogs token, navigate to [this link](https://www.discogs.com/settings/developers) and click the "Generate new token" button.
-* Edit `server/config.json` with your Discogs, Goodreads, and/or BoardGameGeek information. Shelf uses these services to display your library. See the ["Setup"](https://github.com/barrowclift/shelf/blob/master/README.md#setup) section of the [README](https://github.com/barrowclift/shelf/blob/master/README.md) for more information.
-* Finally, continue editing `server/config.json`, replacing all instances of `$PLACEHOLDER` with the appropriate information.
+* Edit `backend/config.json` with your Discogs information. To generate a Discogs token, navigate to [this link](https://www.discogs.com/settings/developers) and click the "Generate new token" button.
+* Edit `backend/config.json` with your Discogs, Goodreads, and/or BoardGameGeek information. Shelf uses these services to display your library. See the ["Setup"](https://github.com/barrowclift/shelf/blob/master/README.md#setup) section of the [README](https://github.com/barrowclift/shelf/blob/master/README.md) for more information.
+* Finally, continue editing `backend/config.json`, replacing all instances of `$PLACEHOLDER` with the appropriate information.
 
 To spin up Shelf, execute `./start.sh`. Be sure to check the `logs/` directory to see if there are any errors.

README.md

@@ -1,5 +1,5 @@
 <a href="#">
-<img height="50" src="https://raw.githubusercontent.com/barrowclift/shelf/master/client/static/images/logo/shelf.png" />
+<img height="50" src="https://raw.githubusercontent.com/barrowclift/shelf/master/frontend/static/images/logo/shelf.png" />
 </a>
 
 ### *Beautifully display your library on the Internet*
@@ -61,7 +61,7 @@ Since [Discogs](https://www.discogs.com), [Goodreads](https://www.goodreads.com)
 
 ## How do I sync my Discogs account with Shelf to display my records?
 
-You will need to make the following changes to Shelf's properties file at `server/resources/shelf.properties`:
+You will need to make the following changes to Shelf's properties file at `backend/resources/shelf.properties`:
 
 1. Set your Discogs username in `discogs.user.id`.
 2. You'll need to generate a [Discogs](https://www.discogs.com) personal access token, which you can do at [the following link](https://www.discogs.com/settings/developers). Copy and paste that token in `discogs.user.token`.
@@ -70,7 +70,7 @@ Note that only records in your collection will be fetched for your Shelf collect
 
 ## How do I sync my Goodreads account with Shelf to display my books?
 
-You will need to make the following changes to Shelf's properties file at `server/resources/shelf.properties`:
+You will need to make the following changes to Shelf's properties file at `backend/resources/shelf.properties`:
 
 1. You'll need to identify your [Goodreads](https://www.goodreads.com) user ID. To do so, log into [Goodreads](https://www.goodreads.com) and navigate to your profile. In your browser's URL, you will see a number preceding your account's name. Take _just_ that number set it in `goodreads.user.id`.
 2. You'll need to generate an API key and secret at [the following link](https://www.goodreads.com/api/keys). Set the key in `goodreads.user.key` and the secret in `goodreads.user.token`. Additionally, set the public address where your Shelf instance will reside in the Callback URL.
@@ -79,7 +79,7 @@ Note that only owned books in your "Read" bookshelf will be fetched for your She
 
 ## How do I sync my BoardGameGeek account with Shelf to display my games?
 
-You will need to make the following changes to Shelf's properties file at `server/resources/shelf.properties`:
+You will need to make the following changes to Shelf's properties file at `backend/resources/shelf.properties`:
 
 1. Set your [BoardGameGeek](https://boardgamegeek.com) username in `boardgamegeek.user.id`.
 
@@ -91,7 +91,7 @@ As mentioned above, if you want to add new items to Shelf, you must add them to
 
 ## What if I only want to display a particular collection, like board games?
 
-By default, records, books, and board games are all displayed in Shelf's menu. However, you can easily disable them via the following properties in `server/resources/shelf.properties`:
+By default, records, books, and board games are all displayed in Shelf's menu. However, you can easily disable them via the following properties in `backend/resources/shelf.properties`:
 
 ```
 boardgame.shelf.enabled=true
@@ -103,7 +103,7 @@ book.shelf.enabled=true
 
 Shelf is a webapp built with [Node.js](https://nodejs.org/en/), [MongoDB](https://www.mongodb.com), and [Vue.js](https://vuejs.org). For the complete list of third-party libraries and tools used, please see Shelf's [Acknowledgements page](https://shelf.barrowclift.me/acknowledgements).
 
-Shelf is run server-side from a single entry point, `server/main.js`, which is started or stopped via `./start.sh` or `./stop.sh`, respectively. Since these bash scripts are powered by [pm2](https://pm2.io/runtime/), Shelf's process can alternatively be managed with [pm2](https://pm2.io/runtime/) directly, if you wish. Books, records, and board games are managed independently in their own, modular directories, so adding new external data sources or media types is a breeze.
+Shelf is run server-side from a single entry point, `admin/main.js`, which is started or stopped via `admin/start.sh` or `admin/stop.sh`, respectively. Since these bash scripts are powered by [pm2](https://pm2.io/runtime/), Shelf's process can alternatively be managed with [pm2](https://pm2.io/runtime/) directly, if you wish. Books, records, and board games are managed independently in their own, modular directories, so adding new external data sources or media types is a breeze.
 
 Client-side, Shelf leverages [Liquid](https://shopify.github.io/liquid/) for its HTML templates.
 

admin/cleanLogs.sh

@@ -4,7 +4,7 @@ export ADMIN_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"
 source "${ADMIN_DIR}"/init.sh
 
 rm "${LOGS_DIR}"/mongodb.log 2> /dev/null
-rm "${LOGS_DIR}"/server.log 2> /dev/null
+rm "${LOGS_DIR}"/backend.log 2> /dev/null
 rm "${LOGS_DIR}"/clean-mongodb.log 2> /dev/null
 
 echo "Log directory cleaned"

admin/init.sh

@@ -6,12 +6,12 @@ export YELLOW='\033[0;33m'
 export GREEN='\033[0;32m'
 
 export REPO=$(dirname "${ADMIN_DIR}")
-export CLIENT_STATIC_DIR="${REPO}"/client/static
-export CLIENT_LIQUID_DIR="${REPO}"/client/liquid
-export SERVER_DIR="${REPO}"/server
-export RECORD_IMAGE_CACHE_DIR="${CLIENT_STATIC_DIR}"/images/records
-export BOARD_GAME_IMAGE_CACHE_DIR="${CLIENT_STATIC_DIR}"/images/board-games
-export BOOK_IMAGE_CACHE_DIR="${CLIENT_STATIC_DIR}"/images/books
+export FRONTEND_STATIC_DIR="${REPO}"/frontend/static
+export FRONTEND_LIQUID_DIR="${REPO}"/frontend/liquid
+export BACKEND_DIR="${REPO}"/backend
+export RECORD_IMAGE_CACHE_DIR="${FRONTEND_STATIC_DIR}"/images/records
+export BOARD_GAME_IMAGE_CACHE_DIR="${FRONTEND_STATIC_DIR}"/images/board-games
+export BOOK_IMAGE_CACHE_DIR="${FRONTEND_STATIC_DIR}"/images/books
 export LOGS_DIR="${REPO}"/logs
 export MONGO_DB=/var/lib/mongo
 

server/main.js renamed to admin/main.js

@@ -5,14 +5,14 @@
 // External
 let path = require("path");
 // Local
-let BoardGameFetcher = require("./boardGames/Fetcher");
-let BookFetcher = require("./books/Fetcher");
-let CachedMongoClient = require("./db/CachedMongoClient");
-let Logger = require("./common/Logger");
-let paths = require("./common/paths");
-let RecordFetcher = require("./records/Fetcher");
-let Server = require("./Server");
-let PropertyManager = require("./common/PropertyManager");
+let BoardGameFetcher = require("../backend/boardGames/Fetcher");
+let BookFetcher = require("../backend/books/Fetcher");
+let CachedMongoClient = require("../backend/db/CachedMongoClient");
+let Logger = require("../backend/common/Logger");
+let paths = require("../backend/common/paths");
+let RecordFetcher = require("../backend/records/Fetcher");
+let Server = require("../backend/Server");
+let PropertyManager = require("../backend/common/PropertyManager");
 
 
 // CONSTANTS
@@ -30,7 +30,7 @@ let bookFetcher = null;
 let server = null;
 
 const log = new Logger(CLASS_NAME);
-let propertiesFileName = path.join(paths.SERVER_RESOURCES_DIRECTORY_PATH, "shelf.properties");
+let propertiesFileName = path.join(paths.BACKEND_RESOURCES_DIRECTORY_PATH, "shelf.properties");
 
 
 // STARTUP

admin/mongoShim.js

@@ -9,15 +9,15 @@ let request = require("request-promise");
 let socketIo = require("socket.io-client");
 // Local
 const SHELF_ROOT_DIRECTORY_PATH = path.join(__dirname, "..");
-let CachedMongoClient = require(path.join(SHELF_ROOT_DIRECTORY_PATH, "server/db/CachedMongoClient"));
-let PropertyManager = require(path.join(SHELF_ROOT_DIRECTORY_PATH, "server/common/PropertyManager"));
-let socketCodes = require(path.join(SHELF_ROOT_DIRECTORY_PATH, "server/common/socketCodes"));
-let util = require(path.join(SHELF_ROOT_DIRECTORY_PATH, "server/common/util"));
+let CachedMongoClient = require(path.join(SHELF_ROOT_DIRECTORY_PATH, "backend/db/CachedMongoClient"));
+let PropertyManager = require(path.join(SHELF_ROOT_DIRECTORY_PATH, "backend/common/PropertyManager"));
+let socketCodes = require(path.join(SHELF_ROOT_DIRECTORY_PATH, "backend/common/socketCodes"));
+let util = require(path.join(SHELF_ROOT_DIRECTORY_PATH, "backend/common/util"));
 
 
 // CONSTANTS
 // ---------
-const PROPERTIES_FILE_NAME = path.join(SHELF_ROOT_DIRECTORY_PATH, "server/resources/shelf.properties");
+const PROPERTIES_FILE_NAME = path.join(SHELF_ROOT_DIRECTORY_PATH, "backend/resources/shelf.properties");
 
 
 // GLOBALS

admin/start.sh

@@ -14,7 +14,7 @@ if [ -n "$HAS_SERVICE_COMMAND" ]; then
         MONGODB_SERVICE_RUNNING=$(systemctl status mongod | grep 'is running\|active (running)')
     fi
 fi
-SHELF_RUNNING=$(ps -ef | grep "node ""${SERVER_DIR}" | grep -v grep)
+SHELF_RUNNING=$(ps -ef | grep "node ""${BACKEND_DIR}" | grep -v grep)
 
 # If all necessary ingredients are running successfully, nothing to do
 if [ -n "$SHELF_RUNNING" ] && { [ -n "$MONGODB_NOHUP_RUNNING" ] || [ -n "$MONGODB_SERVICE_RUNNING" ]; }; then

admin/startServer.sh

@@ -7,15 +7,15 @@ if [ ! -d "$LOGS_DIR" ]; then
     mkdir "$LOGS_DIR";
 fi
 
-SERVER_RUNNING=$(ps -ef | grep "node ""${SERVER_DIR}" | grep -v grep)
+SERVER_RUNNING=$(ps -ef | grep "node ""${ADMIN_DIR}" | grep -v grep)
 
 if [ -n "$SERVER_RUNNING" ]; then
     echo -e "Server already running"
 else
     if [ "$USE_PM2" = true ] ; then
-        pm2 --log "${LOGS_DIR}"/server.log --name shelf --silent start "${SERVER_DIR}"/main.js
+        pm2 --log "${LOGS_DIR}"/backend.log --name shelf --silent start "${ADMIN_DIR}"/main.js
     else
-        nohup node "${SERVER_DIR}"/main.js > "$LOGS_DIR"/server.log 2>&1 &
+        nohup node "${ADMIN_DIR}"/main.js > "$LOGS_DIR"/backend.log 2>&1 &
     fi
 
     SUCCESS=$?

admin/stop.sh

@@ -14,7 +14,7 @@ if [ -n "$HAS_SERVICE_COMMAND" ]; then
         MONGODB_SERVICE_RUNNING=$(systemctl status mongod | grep 'is running\|active (running)')
     fi
 fi
-SERVER_RUNNING=$(ps -ef | grep "node ""${SERVER_DIR}" | grep -v grep)
+SERVER_RUNNING=$(ps -ef | grep "node ""${BACKEND_DIR}" | grep -v grep)
 
 # If all necessary ingredients aren't running, then there's nothing to stop
 if [ -z "$SERVER_RUNNING" ] && { [ -z "$MONGODB_NOHUP_RUNNING" ] && [ -z "$MONGODB_SERVICE_RUNNING" ]; }; then