Comparing version 0.1.0 to 0.1.1-1
{ | ||
"name": "muse", | ||
"version": "0.1.0", | ||
"description": "A CMS scaffolding generator (Coming Soon)", | ||
"version": "0.1.1-1", | ||
"description": "A CMS Scaffolding Tool (Coming Soon)", | ||
"main": "index.js", | ||
"bin": { | ||
"muse": "bin/init" | ||
}, | ||
"scripts": { | ||
"test": "npm test" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/RDFroeber/muse.git" | ||
}, | ||
"keywords": [ | ||
@@ -14,10 +21,7 @@ "CMS", | ||
"author": "Raleigh D. Froeber <RDFroeber@gmail.com> (http://raleighdaniel.com/)", | ||
"license": "MIT", | ||
"bin": { | ||
"muse": "bin/init" | ||
}, | ||
"dependencies": { | ||
"commander": "^2.5.1", | ||
"mkdirp": "^0.5.0" | ||
} | ||
}, | ||
"license": "MIT" | ||
} |
# muse | ||
A CMS scaffolding generator (Coming Soon) | ||
A CMS Scaffolding Tool (Coming Soon) | ||
This package is in the early stages of development. Feel free to browse the code and star for review at a later date. However, use of the module is not recommended at the current version. Basic CMS functionality will be available in the 0.2.0 release. All 0.1.x versions are for project setup and testing. | ||
## Installation | ||
Download node at [nodejs.org](http://nodejs.org) and install it, if you haven't already. | ||
**Note: Current Release Is Not Suitable For Use** | ||
@@ -13,10 +15,62 @@ ```sh | ||
Source code can be found [here](https://github.com/RDFroeber/muse). | ||
## Usage | ||
While many command options are listed here, very few are actually implemented to date. I will update this document as more become available. | ||
```sh | ||
muse init | ||
Usage: muse init [options] | ||
Options: | ||
-h, --help output usage information | ||
-V, --version output the version number | ||
-c, --css <engine> add stylesheet engine support (sass|less) | ||
-f, --framework <name> add client-side framework support (angular|ember) | ||
``` | ||
## Development Task List | ||
* Finalize default configuration and structure | ||
* Basic mongoose models and CRUD operations for Users, Pages, Blogs, and Posts | ||
* Separate view routes from API routes in preparation for client-side framework support | ||
* User Authentication (Passport) | ||
* Basic user auth | ||
* OAuth support for Google+, Twitter, and Facebook | ||
* Both | ||
* Blog functionality | ||
* Single blog with multiple posts (without comments) | ||
* Single blog with multiple posts (with comments) | ||
* Admin functionality without permissions | ||
* Admin functionality with roles and multi-part permissions | ||
* Content creation and editing | ||
* Content publication | ||
* Content deletion | ||
* User viewing | ||
* User creation and editing | ||
* Navigation | ||
* Single top level page routing | ||
* Additional secondary level routing | ||
### Backlog | ||
* Add tutorial option for base website generation | ||
* Email system support (Mailgun) | ||
* Account creation | ||
* Newsletters | ||
* Add multiple client-side framework support | ||
* Angular | ||
* Ember | ||
* Backbone | ||
* Add multiple Node.js framework support | ||
* Loopback | ||
* Sails | ||
* Multi-blog support | ||
## Tests | ||
Not implemented. | ||
```sh | ||
@@ -29,3 +83,3 @@ npm install | ||
- [commander](https://github.com/tj/commander.js): the complete solution for node.js command-line programs | ||
- [commander](https://github.com/tj/commander.js): The complete solution for node.js command-line programs | ||
- [mkdirp](https://github.com/substack/node-mkdirp): Recursively mkdir, like `mkdir -p` | ||
@@ -35,3 +89,3 @@ | ||
None | ||
None as of now. | ||
@@ -38,0 +92,0 @@ ## License |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
5512
6
92
0