[qomet.git] / setup / README

## Prerequisites

node (v.6.10+), npm, mongo (v3.4+)

msmtp: for sending e-mails

git-fat: for large binary objects

## Local installation

First of all:
    npm i

Copy the files config/\*.js.dist without .dist extension.
Adjust their content to your liking (especially DB name and user & mail settings).

Then start mongodb service, create a database and user corresponding to the parameters,
and run the mongo script database.js in setup/ folder:
    load("setup/database.js") [from mongo shell]

All should be good now:
    npm start

Note the "student.csv.sample" file in this folder, to test features locally.
Commit	Line	Data
	1	## Prerequisites
	2
	3	node (v.6.10+), npm, mongo (v3.4+)
	4
	5	msmtp: for sending e-mails
	6
	7	git-fat: for large binary objects
	8
	9	## Local installation
	10
	11	First of all:
	12	npm i
	13
	14	Copy the files config/\*.js.dist without .dist extension.
	15	Adjust their content to your liking (especially DB name and user & mail settings).
	16
	17	Then start mongodb service, create a database and user corresponding to the parameters,
	18	and run the mongo script database.js in setup/ folder:
	19	load("setup/database.js") [from mongo shell]
	20
	21	All should be good now:
	22	npm start
	23
	24	Note the "student.csv.sample" file in this folder, to test features locally.