From 8a5afe38cd44dce99ca2c5959c2fb2f4aabb6f8b Mon Sep 17 00:00:00 2001 From: ArcaneDisgea <39720490+ArcaneDisgea@users.noreply.github.com> Date: Mon, 17 Oct 2022 18:18:32 -0400 Subject: [PATCH] index to server because deployment needs it I guess --- .npmignore | 2 +- package.json | 4 ++-- readme.md | 2 +- index.js => server.js | 0 4 files changed, 4 insertions(+), 4 deletions(-) rename index.js => server.js (100%) diff --git a/.npmignore b/.npmignore index 1080c8a..c965749 100644 --- a/.npmignore +++ b/.npmignore @@ -1,4 +1,4 @@ -index.js +server.js docs/ gh-pages.js .github/ \ No newline at end of file diff --git a/package.json b/package.json index bfdeeda..c81a214 100644 --- a/package.json +++ b/package.json @@ -10,8 +10,8 @@ "xivapi" ], "scripts": { - "start": "node index.js", - "dev": "nodemon index.js", + "start": "node server.js", + "dev": "nodemon server.js", "docs:generate": "jsdoc create-card.js -d docs -R readme.md", "docs:deploy": "npm run docs:generate && node gh-pages.js" }, diff --git a/readme.md b/readme.md index d816662..a710cd6 100644 --- a/readme.md +++ b/readme.md @@ -49,7 +49,7 @@ You can then instantiate the class `CardCreator` from the library, call the asyn Check the [library documentation](https://xivapi.github.io/XIV-Character-Cards/) for more details. -> **Note:** The API server is not published as an NPM package, so if you want to host it yourself, clone the [Github repository](https://github.com/xivapi/XIV-Character-Cards) and put the Express.JS webserver defined in the `index.js` file behind a reverse proxy. +> **Note:** The API server is not published as an NPM package, so if you want to host it yourself, clone the [Github repository](https://github.com/xivapi/XIV-Character-Cards) and put the Express.JS webserver defined in the `server.js` file behind a reverse proxy. ### Library example diff --git a/index.js b/server.js similarity index 100% rename from index.js rename to server.js