Merge pull request #98 from tycrek/npm-8-stuff

pull/99/head
Josh Moore 3 years ago committed by GitHub
commit d1c8a390cf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -11,7 +11,7 @@
- Operating System:
- Node version:
- NPM version:
- npm version:
## Description
<!-- Describe your PR in detail. Include links to any relevant Issues. -->

14
.github/README.md vendored

@ -189,7 +189,7 @@ docker-compose up --force-recreate --build -d && docker image prune -f # && dock
<summary><em>Expand for local installation steps</em></summary>
<br>
1. You should have **Node.js 14** & **npm 7 or later** installed.
1. You should have **Node.js 14.17** & **npm 8 or later** installed.
2. Clone this repo using `git clone https://github.com/tycrek/ass.git && cd ass/`
3. Run `npm i -g typescript` to install TypeScript globally
4. Run `npm i --save-dev` to install the required dependencies (`--save-dev` is **required** for compilation)
@ -333,21 +333,21 @@ ass is intended to provide a strong backend for developers to build their own fr
| Name | Description | Links |
| :--: | ----------- | :---: |
| **JSON** | JSON-based data storage. On disk, data is stored in a JSON file. In memory, data is stored in a [Map]. This is the default engine. | [GitHub][GH ASE]<br>[NPM][NPM ASE] |
| **PostgreSQL** | Data storage using a [PostgreSQL] database. [node-postgres] is used for communicating with the database. | [GitHub][GH APSQL]<br>[NPM][NPM APSQL] |
| **Mongoose** | Data storage using a [MongoDB] database. [mongoose] is used for communicating with the database. Created by [@dylancl] | [GitHub][GH AMongoose]<br>[NPM][NPM AMongoose] |
| **JSON** | JSON-based data storage. On disk, data is stored in a JSON file. In memory, data is stored in a [Map]. This is the default engine. | [GitHub][GH ASE]<br>[npm][npm ASE] |
| **PostgreSQL** | Data storage using a [PostgreSQL] database. [node-postgres] is used for communicating with the database. | [GitHub][GH APSQL]<br>[npm][npm APSQL] |
| **Mongoose** | Data storage using a [MongoDB] database. [mongoose] is used for communicating with the database. Created by [@dylancl] | [GitHub][GH AMongoose]<br>[npm][npm AMongoose] |
[Map]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map
[GH ASE]: https://github.com/tycrek/papito/
[NPM ASE]: https://www.npmjs.com/package/@tycrek/papito
[npm ASE]: https://www.npmjs.com/package/@tycrek/papito
[PostgreSQL]: https://www.postgresql.org/
[node-postgres]: https://node-postgres.com/
[GH APSQL]: https://github.com/tycrek/ass-psql/
[NPM APSQL]: https://www.npmjs.com/package/@tycrek/ass-psql
[npm APSQL]: https://www.npmjs.com/package/@tycrek/ass-psql
[MongoDB]: https://www.mongodb.com/
[mongoose]: https://mongoosejs.com/
[GH AMongoose]: https://github.com/dylancl/ass-mongoose
[NPM AMongoose]: https://www.npmjs.com/package/ass-mongoose
[npm AMongoose]: https://www.npmjs.com/package/ass-mongoose
[@dylancl]: https://github.com/dylancl
A Papito data engine implements support for one type of database (or file, such as JSON or YAML). This lets ass server hosts pick their database of choice, because all they'll have to do is enter the connection/authentication details, and ass will handle the rest, using the resource ID as the key.

@ -12,9 +12,9 @@ WORKDIR /opt/ass/
# Copy directory files (config.json, source files etc.)
COPY . ./
# Update npm to at least v7.x.x,
# Update npm to at least npm 8,
# then install dependencies
RUN npm i -g npm@7 typescript && \
RUN npm i -g npm@8 typescript && \
npm i --save-dev && \
npm run build

1671
package-lock.json generated

File diff suppressed because it is too large Load Diff

@ -5,7 +5,7 @@
"main": "ass.js",
"engines": {
"node": ">=14.7.x <16",
"npm": ">=7.x.x"
"npm": ">=8.1.x"
},
"scripts": {
"dev": "npm run build && npm start",
@ -64,7 +64,6 @@
"sanitize-filename": "^1.6.3",
"stream-to-array": "^2.3.0",
"submodule": "^1.2.1",
"ts": "^0.2.2",
"uuid": "^8.3.2"
},
"devDependencies": {

@ -161,7 +161,7 @@ function doSetup() {
required: false
},
dataEngine: {
description: 'Data engine to use (must match an NPM package name. If unsure, leave blank)',
description: 'Data engine to use (must match an npm package name. If unsure, leave blank)',
type: 'string',
default: config.dataEngine,
required: false

Loading…
Cancel
Save