Getting Started

Setting up Your Development Environment

Database Setup

We'll start by getting setup with an instance of MongoDB; there are a few ways to create a database instance for use with Quill. As listed below you can either host the database locally or using an web service that provides MongodDB instances online. Either will work, the choice is up the the preference of the developer; just make sure that however you set it up, you get a connection string that you can configure in Quill.

Local instance

Linux

Ideally, you should run MongoDB as a daemon with a secure configuration (with most linux distributions, you should be able to install it with your package manager, and it'll be set up as a daemon). Although not recommended for production, when running locally for development, you could do it like this:

mkdir db
mongod --dbpath db --bind_ip 127.0.0.1 --nohttpinterface

MacOS

Ensure nvm is installed, and run nvm use {Node Version} based on the node version specified in the .env file Install Necessary Dependancies with npm install You may need to install additional dependancies depending on the results of the previous command. Update .env with the mongodb connection string and other necessary changes.

Windows

Information about setting up an instance of MongoDB on a Windows machine can be found here

Online MongoDB Providers

Because there is infrequent need for database management in Quill, it can be easier and faster to use an online service to host the database for you. Downsides to this approach include, creating an account with the provider, requirement of network connection to access the database, potential risk of hacking.

MongoDB Atlas

MongoDB Atlas is an example of such a service, information on how to setup a cluster and get its connection string can be found here For more information about Quill's database design and MongoDB, see the Database Page of the Project Architecture section of this wiki.

---

Installing and configuring

Install the necessary dependencies:

npm install
bower install
npm run config

Edit the configuration file in .env for your setup, and then run the application:

gulp server