mohammedfoysal/kayknows

KayKnows

KayKnows presents the new design for the career lattice, no longer will you have to look at a table. Now you can navigate the career ladder with a wonderful tree!!!!

Setup the Database

• Navigate to the KayKnows-database directory.

• Open a mysql environment and run the knows_db_tables.sql file to setup the development/production database.

• In the same environment run the knows_test_db.sql file to set up the test database.

• Make a user that has permissions to SELECT for the generated tables.

• If you want the development database to be populated with some dummy data run the chunky_dummy.sql file.

How to Run

Running Express

To run express first make sure that the database is setup.

• To run express first navigate to the KayKnows-backend directory.

• Then ensure that npm is set up by running

  npm install

• Ensure that a mysql.env file is located within the directory with the following content:

  DB_HOST= #host
  DB_USER= #mysql user
  DB_PASS= #password
  DB_DATABASE= #dev/production database
  DB_TEST_DATABASE= #test database

• Install nodemon

• To start express run

  npm start

Running Angular

To ensure that data is being transfered make sure that you follow the steps to run express and setup mysql.

• To run angular first navigate to the KayKnows-frontend directory.

• Ensure that everything is setup by running:

  npm install

• To start the application run:

  npm start

How to Test

Testing Express

To test express first ensure that the database is setup from the mysql section.

• Set up npm with:

  npm install

• Run with:

  npm test

• A HTML report is generated in the results directory

Testing Angular

When testing the angular front end ensure that express is setup and running.

• Ensure that everything is installed with:

  npm install

• To start the tests run:

  ng test

API Document Generator

Install your generator of choice, this guide will assume that you are using raml2html.

From the root directory run the following command:

raml2html -i kayknows_api.raml -o kayknows_api.html

The generated file can then be viewed. Whilst the generated file can be called anything, to ensure that it is still ignored by the .gitignore make sure that the name of the file is kayknows_api.