# niece
> Inline-Edited CMS in Node.js and Express.
Latest version **0.0.10** (published 2021-05-14) · ISC license · 0 weekly downloads
## Install
```sh
npm install niece
pnpm add niece
yarn add niece
bun add niece
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.0.10 |
| Published | 2021-05-14 |
| First published | 2021-04-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 20 |
| Unpacked size | 123.9 KB |
| Known vulnerabilities | 0 (+24 in 5 direct dependencies) |
| Install scripts | no |
| Author | BOXNYC |
| Maintainers | boxnyc |
## Links
- npm: https://www.npmjs.com/package/niece
- npm.io page: https://npm.io/package/niece
## Dependencies (20)
- [fs](https://npm.io/package/fs.md) *
- [path](https://npm.io/package/path.md) ^0.12.7
- [bcrypt](https://npm.io/package/bcrypt.md) ^5.0.1
- [dotenv](https://npm.io/package/dotenv.md) ^8.2.0
- [pretti](https://npm.io/package/pretti.md) ^2.0.1
- [express](https://npm.io/package/express.md) ^4.17.1
- [tingodb](https://npm.io/package/tingodb.md) ^0.6.1
- [tinymce](https://npm.io/package/tinymce.md) ^5.7.1
- [passport](https://npm.io/package/passport.md) ^0.4.1
- [dateformat](https://npm.io/package/dateformat.md) ^4.5.1
- [get-routes](https://npm.io/package/get-routes.md) ^2.1.1
- [handlebars](https://npm.io/package/handlebars.md) ^4.7.7
- [nodemailer](https://npm.io/package/nodemailer.md) ^6.5.0
- [jsonwebtoken](https://npm.io/package/jsonwebtoken.md) ^8.5.1
- [express-flash](https://npm.io/package/express-flash.md) ^0.0.2
- [passport-local](https://npm.io/package/passport-local.md) ^1.0.0
- [express-session](https://npm.io/package/express-session.md) ^1.17.1
- [method-override](https://npm.io/package/method-override.md) ^3.0.0
- [express-fileupload](https://npm.io/package/express-fileupload.md) ^1.2.1
- [express-handlebars](https://npm.io/package/express-handlebars.md) ^5.3.0
## Recent versions
- 0.0.10 (latest) — 2021-05-14
- 0.0.9 — 2021-05-13
- 0.0.8 — 2021-05-11
- 0.0.7 — 2021-05-08
- 0.0.6 — 2021-05-08
- 0.0.5 — 2021-05-08
- 0.0.4 — 2021-05-08
- 0.0.3 — 2021-05-08
- 0.0.2 — 2021-04-27
- 0.0.1 — 2021-04-27
## README
NIECE
Node.js Inline-Edited-Content &
Express
### What's NIECE?
NIECE is full-stack CMS built entirely within a
single npm module package. It's unique because it
doen't really have an admin panel and all content is
editable inline on the front-end. This makes it an
[iCMS or an adminless CMS](#iCMS).
The back-end structure is built very similarly to
Drupal CMS, and does just about as much.
### Features
- Bootstrap theme
- Written entirely in Javascript (Node.js).
- User system with roles, permissions, and email verification.
- Media upload system.
- Extendable using npm modules with the prefix name of "niece_"
- and more...
You can see it in action here: http://niece.box.biz/ in fact that site is the default site the module ships with.
## Install
Assuming that you have installed node.js.
Using just NPM
Site in under a minute using terminal:
1. Build your node app: `npm init`. _Note: use "index.js" for your entry point, if ya want the rest of the scripts to work._
2. Create your app file `printf '%s\n' 'const Neice = require("niece");' 'new Neice();' > index.js`
3. Install nodemon and npm-add-script to help with development: `npm install -g nodemon npm-add-script`
4. Add your dev script `npmAddScript -k dev -v "nodemon index.js"`
5. Install NIECE `npm install niece`
7. Run your app: `npm run dev` which will build the site and listen at port 4430. Your site will be http://localhost:4430/
8. Go to http://localhost:4430/user/register and create your admin account.
#### That's it!
Few notes:
- To restart just run `rs`
- Type control+z to end the sever
- Run `kill -9 $(lsof -t -i:4430)` to stop listening on port 4430
#### Install in a single script!
```
npm init -f
printf '%s\n' 'const Neice = require("niece");' 'new Neice();' > index.js
npm install -g nodemon npm-add-script
npmAddScript -k dev -v "nodemon index.js"
npm install niece
open -na "Firefox" --args --new-window "javascript:setTimeout(()=>window.location.href='http://localhost:4430', 4000)"
npm run dev
# done
```
Using Github and NPM
Assuming you have git and node.js installed.
Git a base app `git clone https://github.com/BOXNYC/NIECE.git`
Go to it's directory `cd niece`
Install it via npm `npm install`
Run it `npm run dev`
#### Install in a single script!
```
git clone https://github.com/BOXNYC/niece.git
cd niece
npm install
npm run dev
# done
```
## Run on a webserver
Apache OpenSSL
On your httpd.conf file add a VHOST that passes the traffic to your NIECE app's port:
#### Non-Secure http:// (port 80)
```
ServerName niece.box.biz
# Set up the proxy both ways
SSLProxyEngine On
ProxyPass / http://localhost:4430/
ProxyPassReverse / http://localhost:4430/
ProxyPreserveHost On
```
#### Secure https:// (port 443)
```
ServerName niece.box.biz
# Set up the proxy both ways
SSLProxyEngine On
ProxyPass / http://localhost:4430/
ProxyPassReverse / http://localhost:4430/
ProxyPreserveHost On
# Turn on SSL
SSLEngine on
SSLCertificateFile /etc/ssl/2/STAR_box_biz.crt
SSLCertificateKeyFile /etc/ssl/2/box_biz.key
SSLCertificateChainFile /etc/ssl/2/My_CA_Bundle.ca-bundle
```
---
_Source: https://npm.io/package/niece · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._