title: EdenJS

EdenJS is a powerful Node.js content management system and web app framework built on express and mongoose. EdenJS makes it easy to create sophisticated web sites, apps, and blockchains. Comes with a beautiful auto-generated Admin UI, a la django.

About

EdenJS gives you:

• A simple way to create a dynamic web site or app with well-structured routes, templates and models
• A beautiful Admin UI based on the database models you define
• Enhanced models with additional field types and functionality, building on those natively supported by Mongoose
• Out of the box session management and authentication
• An updates framework for managing data updates or initialisation
• Integration with Cloudinary for image uploading, storage and resizing
• Integration with Mandrill for sending emails easily
• Integration with Google Places for clever location fields
• Integration with Embedly for powerful video and rich media embedding tools

... plus a lot of other tools and utilities to make creating complex web apps easier.

Contributing

If you can, please contribute by reporting issues, discussing ideas, or submitting pull requests with patches and new features. We do our best to respond to all issues and pull requests within a day or two, and make patch releases to npm regularly.

If you're going to contribute code, please follow our coding standards and read our CONTRIBUTING.md.

Usage

Details coming soon

Installation

Alternatively, to include EdenJS in an existing project or start from scratch (without Yeoman), specify edenjs: "^1.0.0" in the dependencies array of your package.json file, and run npm install from your terminal.

Configuration

Config variables can be passed in an object to the eden.init method, or can be set any time before eden.start is called using eden.set(key, value). This allows for a more flexible order of execution (e.g. if you refer to Lists in your routes, you can set the routes after configuring your Lists, as in the example above).

Running EdenJS in Production

When you deploy your EdenJS app to production, be sure to set your ENV environment variable to production. You can do this by setting NODE_ENV=production in your .env file, which gets handled by dotenv.

Setting your environment enables certain features, including template caching, simpler error reporting and html minification, that are important in production but annoying in development.

Linking EdenJS for Development and Testing

If you want to test or develop against the master branch of EdenJS (or against your own branch), rather than a published version on npm, you just need to check it out then use npm link to link it to your project. On Mac OS, this is done like this:

• Clone EdenJS locally, e.g. to ~/Development/EdenJS
• From the EdenJS directory, run sudo npm link (you will need to enter your system password)
• From your project directory, e.g. ~/Development/MySite (the one with your package.json file in it) run npm link edenjs. This will create a link between ~/Development/MySite/node_modules/edenjs and ~/Development/EdenJS.

Then require('edenjs') normally in your app - the development copy will be used. Note that running npm update will ignore new versions of EdenJS that have been published.

To go back to using a published version of EdenJS from npm, from your project directory, run npm unlink edenjs then npm install.

Testing

To run the test suite run npm test.

Thanks

This project is based on KeystoneJS by Jed Watson and Thinkmill.

KeystoneJS is a free and open source community-driven project. Thanks to our many contributors and users for making it great.

License

(The MIT License)

Copyright (c) 2018 Don't Panic Consulting Copyright (c) 2016 Jed Watson

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.