yalento-fullstack

Yalento fullstack

This awesome package creates a fullstack web application. Angular as the frontend and firebase as the backend. There is a simple but fully automated workflow with swagger definitions from that integration tests and models are automatically generated. With this package, the Swagger sample project http://editor.swagger.io/ can be implemented in a few minutes.

• Automated integration tests (swagger definitions against backend, intelligent auto-mocking)
• Including bitbucket pipeline
• Automated generation of models and json-schema based on swagger definitions
• Swagger editor included
• Compile time and runtime checks (interfaces and validators)

Install first

• Node.js
• Java SE Runtime

1. Global packages

npm install -g firebase-tools @angular/cli

2. Create angular app

ng new app && cd ./app

3. Init new firebase project

• Add database, firestore, functions, hosting and emulators.
• Select always default values if you are asked from firebase cli.
• Select functions, firestore, database and hosting for Emulator Setup.
• Select typescript if you are asked for.

firebase init

4. Add yalento packages

npm add yalento-fullstack yalento

5. Ready to develop

Fullstck developing with live-reload

• npm run start (ng serve)
• npm run yalento:compile:watch
• npm run yalento:backend:serve

More npm commands

• npm run swagger:edit: Open swagger editor ui in browser.
• npm run yalento:test:api: Test swagger definitions against firebase backend.

You can edit ./swagger.yaml in your project root in your ide as well. 'yalento:compile:watch' is detecting changes. The generated swagger documentation get published automatically here: /swagger/index.html

6. Having fun

Import automatically generated models and schema validators

import {Pet, Validator} from 'yalento-fullstack';

const pet: Pet = {
  name: 'bunny'
};

Validator.Pet(pet).catch((error) => console.log(error));

• This will console.log an error with detailed infos why data is not matching against the definitions in ./swagger.yaml (runtime check)
• The above code cannot be built using the typescript compiler because the interface is wrong (compile time check)

Compatible with Yalento (Browser and node.js)

import { Pet } from 'yalento-fullstack';
import { Repository, IEntity } from 'yalento';

const repository: Repository<Pet> = new Repository(Pet, 'Pet');
const bunny: IEntity<Pet> = await repository.create({ name: 'Bunny'});
const animals: Array<IEntity<Pet>> = repository.select({ where: 'name LIKE "Bunny"'}).getResults();

Read more about Yalento.

7. Publishing your app to production

Yalento Fullstack generates automatically a ready to use bitbucket-pipelines.yml. Just add repository variables FIREBASE_TOKEN_CI with your firebase cli token how to generate read here.