Skip to content

backend design

Lea Anthony edited this page Jan 27, 2019 · 2 revisions

The backend will need to perform various functions. These are divided up into the following services:

Config

Dryw config related functions.

  • Load() => DrywConfig Loads the Dryw configuration.

  • Save(DrywConfig) Saves the Dryw configuration.

DrywConfig: User: { name, email }, Projects: [ {name, path, details} ], Preferences: { key: value },

System

Functions related to the User's system

  • DependencyStatus() => SystemDependencies Returns a list of Dependencies and their status

SystemDependencies: dependencies: [ { id, name, type, help } ]

Project

  • GetProjectTypes() => ProjectTypes Returns a list of available project types

ProjectTypes: types: [ProjectType]

ProjectType: id, name, author, description, source

  • GenerateProject(ProjectDetails) => Project Generates a project using the given project details

ProjectDetails: ProjectType, name, target directory

Build

Build related functions

  • Build(Project)

Clone this wiki locally