Link Search Menu Expand Document (external link)

Getting started

This page aims to give a quick install guide for testing the kestrel project.

Prerequisities

  • Latest LTS of Node.js
  • Nodemon globally installed
  • Any kind of database installed

1- Install the kestrel-cli

$ npm install --global @kestrels/cli

2- Create a new project

$ kc new <project_name>

3- Configure the database access in backend/.env

# BDD config DEVELOMENT
DB_USERNAME_DEV=
DB_PASSWORD_DEV=
DB_SCHEMA_DEV=

# https://sequelize.org/v5/manual/dialects.html
DB_DIALECT_DEV=mysql

4- Initialize the database

$ kc initdb

5- Running the app

$ kc start

6- Point your web browser to http://localhost:4200.

By default you can access the backend on http://localhost:4000 and the frontend on http://localhost:4200.

The API documentation can be accessed on http://localhost:4000/api-docs.