0.1.0 • Published 6 years ago

yggdrasil-arch v0.1.0

Weekly downloads
1
License
MIT
Repository
-
Last release
6 years ago

Create applications easy to scale and full-featured.

Yggdrasil architecture makes easy to create javascript backend applications. Using TypeScript features, it makes easy to scale and maintain them as well.

Prerequisites

  • Install NodeJS (Yggdrasil recommends to use nvm)
  • Install yarn (Yggdrasil recommends to use yarn to build its applications)

Getting Started

To start to use yggdrasil architecture, you could use the starter project:

git clone https://github.com/yggdrasilts/yggdrasil-starter.git [PROJECT_NAME]
cd [PROJECT_NAME]
yarn install
yarn start

The default access is in http://localhost:3000.

Built With

Yggdrasil uses the following frameworks/tools to be developed.

  • NodeJS - A JavaScript runtime built on Chrome's V8 JavaScript engine.
  • TypeScript - A superset of JavaScript.
  • Expressjs - Fast, unopinionated, minimalist web framework for Node.js.
  • yarn - Fast, reliable and secure dependency management.
  • npm - The package manager for JavaScript and the world’s largest software registry.
  • Lerna - A tool for managing JavaScript projects with multiple packages.
  • TSLint - An extensible linter for the TypeScript language.
  • Mocha - Mocha is a feature-rich JavaScript test framework running on Node.js and in the browser, making asynchronous testing simple and fun
  • Istanbul - JavaScript test coverage made simple.
  • Gulp - Gulp is a toolkit for automating painful or time-consuming tasks in your development workflow, so you can stop messing around and build something.

Yggdrasil modules

Yggdrasil is divided in the following modules to give all its functionalities:

  • @yggdrasil/core: Core module provides common and basic functionality that allows an yggdrasil application runs.
  • @yggdrasil/mvc: MVC module provides basic mvc functionalities.
  • @yggdrasil/security: Security module provides all the security functionalities that all kind of application needs.
  • @yggdrasil/data: Data module is powered by typeorm, a powerful TypeScript ORM, and provides all the functionalities to connect and use a variety of databases.
  • @yggdrasil/testing: Testing modules provides functionalities to have all yggdrasil application well tested.
  • @yggdrasil/devs: Devs modules is a modules only thought for development purpose and contains all the necessary to develop any yggdrasil application.

Author / Contributors

  • telco2011 - Telecom engineer, developer enthusiastic 👾, inline skates lover, biker 🏍, coffee lover and barista initiated ☕️.

License

This project is licensed under the MIT License - see the LICENSE.md file for details