Getting Started

Installation

• install Node.js
• clone: https://github.com/LUCCA-Capstone/LUCCA.git

---

Getting dependencies

Open a console and run npm install inside the root directory of lucca . This will download all dependencies being used by LUCCA.

Note - If you plan to use the predefined Model, Migration, and/or Seeder files that are included with the LUCCA package, or you want to auto-generate your own files, you will need to also install sequelize-cli by running the additional command: npm install -g sequelize-cli inside the root directory of lucca.

Note - Refer to the Models | Migrations | Seeders page for sequelize-cli uses and examples after you have finished setting up your postgres database as described below.

---

Setting up Postgres database

You will first need to choose where you want to have your postgres database hosted. You have many Premium options, and very few Free options. If you are using the LUCCA software in a university environment you should find out what database services your university offers, if any, and whether or not you can use them.

Once you have decided where to host your postgres database you will need to locate the lucca.conf and find the [Database] section, edit the following with the appropriate information for your postgres database setup as defined by the configuration settings from the service of your choosing.

username = <username>
password = <password>
database = <database_test>
host = <host>
port = <port>
dialect = <postgres>
logging = <false>

remote_hostname= <remote_hostname>

remote_port= <remote_port>

---

Starting LUCCA

Inside the root directory of LUCCA run the command npm start.

Note - If you plan to use the predefined Model, Migration, and Seeder files that are included with the LUCCA package you will need to run these commands inside the root directory of lucca:

LUCCA>sequelize db:migrate
LUCCA>sequelize db:seed:all
LUCCA>npm start

If all commands above work then that means the [database] configurations were setup correctly and the LUCCA system is now online.