Repository structure - Revision history

Seagame: /* schemas/ObjectTypes.js */

2025-01-17T02:08:06Z

schemas/ObjectTypes.js

← Older revision		Revision as of 02:08, 17 January 2025
Line 80:		Line 80:

	== schemas ==		== schemas ==

	~~=== schemas/ObjectTypes.js ===~~

	* file that lists all objectTypes controlled by this service

	=== schemas/ObjectRelationships.js ===		=== schemas/ObjectRelationships.js ===

Seagame: /* schemas */

2024-02-09T06:20:09Z

schemas

← Older revision		Revision as of 06:20, 9 February 2024
Line 81:		Line 81:
	== schemas ==		== schemas ==

	=== schemas/~~objectList~~.js ===		=== schemas/ObjectTypes.js ===

	* file that lists all objectTypes controlled by this service		* file that lists all objectTypes controlled by this service

	=== schemas/~~objectRelationships~~.js ===		=== schemas/ObjectRelationships.js ===

	* File that lists relationshipTag that responsible by this service		* File that lists relationshipTag that responsible for this service
	* Each relationshipTag ~~show~~ parent and children objType that use this relationshipTag		* Each relationshipTag shows parent and children objType that use this relationshipTag

	=== schemas/~~refObjectRelationships~~.js ===		=== schemas/RefObjectRelationships.js ===

	* Show relationshipTag of each objType in service		* Show relationshipTag of each objType in service
	* Point to service that responsible for relationshipTag		* Point to service that responsible for relationshipTag

	=== schemas/~~objectFields~~ ===		=== schemas/{folderName}/ObjectFieldSchema.js ===

	* ~~sub-folder with one file per object type~~		* normally folderName will be the name of objectType and ObjectFieldSchema.js will contain objectSchema of objectType.
	* fields for data that is set by a user and ~~stored in state such as a database~~		* ObjectFieldSchema.js can contain multiple objectSchema in one file, When contain multiple ojectSchema mostly will contain parent objectSchema and objectSchema that extended from the parent.
	* each file exports a javascript object and each file is one objectType with it's objectType ~~as the filename~~

	~~=== schemas/objectCalculatedData ===~~

	* ~~sub-folder with~~ one file ~~per object type~~
	* fields for data that is calculated, ~~may or may not be stored in state~~
	* each file exports a javascript object and ~~each file is one objectType with it's objectType as~~ the ~~filename~~

	== Source ==		== Source ==

Seagame: /* schemas */

2023-12-25T08:05:14Z

schemas

← Older revision		Revision as of 08:05, 25 December 2023
Line 87:		Line 87:
	=== schemas/objectRelationships.js ===		=== schemas/objectRelationships.js ===

	* ~~file~~ that lists ~~all~~ parent ~~objects~~ and ~~relationship types~~ for ~~objects controlled by the server~~		* File that lists relationshipTag that responsible by this service
			* Each relationshipTag show parent and children objType that use this relationshipTag

			=== schemas/refObjectRelationships.js ===

			* Show relationshipTag of each objType in service
			* Point to service that responsible for relationshipTag

	=== schemas/objectFields ===		=== schemas/objectFields ===

Sven the Barbarian at 01:46, 11 May 2023

2023-05-11T01:46:27Z

← Older revision		Revision as of 01:46, 11 May 2023
Line 30:		Line 30:

	Landing page when viewing the project on repository host		Landing page when viewing the project on repository host

			=== GenerateCode.js ===

			Standard script that invokes npm library to generate code for this service

	= app project =		= app project =
Line 47:		Line 51:
	== src ==		== src ==

	Per service logic, can be split into subfolders per object or work flow, up to developers		Per service logic created by developers (not generated), can be split into subfolders per object or work flow, up to developers

	=== Lambda function filenames ===		=== Lambda function filenames ===
Line 67:		Line 71:
	* ThisFunctionYyNodeUpdated_HdrSqs		* ThisFunctionYyNodeUpdated_HdrSqs

			=== Developer code added to generated code ===

			When adding developer code into generated code we place the developer code into /src/{objectType}/{generated file type}.js files, example adding code to SellOffer > Create handler would be in /src/SellOffer/Create.js

	=== lib ===		=== lib ===
Line 93:		Line 100:
	* fields for data that is calculated, may or may not be stored in state		* fields for data that is calculated, may or may not be stored in state
	* each file exports a javascript object and each file is one objectType with it's objectType as the filename		* each file exports a javascript object and each file is one objectType with it's objectType as the filename

			== Source ==

			Code created by code generation from project schemas, do not edit these files by hand as they are auto-generated and disposable.

	== __test__ ==		== __test__ ==

Sven the Barbarian: /* schemas */

2023-04-10T15:05:51Z

schemas

← Older revision		Revision as of 15:05, 10 April 2023
Line 76:		Line 76:
	=== schemas/objectList.js ===		=== schemas/objectList.js ===

	* file that lists all ~~object types~~ controlled by this service		* file that lists all objectTypes controlled by this service

	=== schemas/objectRelationships.js ===		=== schemas/objectRelationships.js ===
Line 86:		Line 86:
	* sub-folder with one file per object type		* sub-folder with one file per object type
	* fields for data that is set by a user and stored in state such as a database		* fields for data that is set by a user and stored in state such as a database
			* each file exports a javascript object and each file is one objectType with it's objectType as the filename

	=== schemas/objectCalculatedData ===		=== schemas/objectCalculatedData ===
Line 91:		Line 92:
	* sub-folder with one file per object type		* sub-folder with one file per object type
	* fields for data that is calculated, may or may not be stored in state		* fields for data that is calculated, may or may not be stored in state
			* each file exports a javascript object and each file is one objectType with it's objectType as the filename

	== __test__ ==		== __test__ ==

Sven the Barbarian at 15:04, 10 April 2023

2023-04-10T15:04:52Z

← Older revision		Revision as of 15:04, 10 April 2023
Line 71:		Line 71:

	The lib folder stores functions that are used by multiple Lambda functions		The lib folder stores functions that are used by multiple Lambda functions

			== schemas ==

			=== schemas/objectList.js ===

			* file that lists all object types controlled by this service

			=== schemas/objectRelationships.js ===

			* file that lists all parent objects and relationship types for objects controlled by the server

			=== schemas/objectFields ===

			* sub-folder with one file per object type
			* fields for data that is set by a user and stored in state such as a database

			=== schemas/objectCalculatedData ===

			* sub-folder with one file per object type
			* fields for data that is calculated, may or may not be stored in state

	== __test__ ==		== __test__ ==

Sven the Barbarian at 08:59, 22 February 2023

2023-02-22T08:59:24Z

@@ Line 47: / Line 47: @@
 == src ==
-Per service logic
+Per service logic, can be split into subfolders per object or work flow, up to developers
 === lib ===

Sven the Barbarian: Created page with "= Overview = Standard file and folder for each backend microservice. = Root directory = == app == The ''app'' folder holds all logic for the service, the files inside this..."

2020-11-06T11:20:46Z

Created page with "= Overview = Standard file and folder for each backend microservice. = Root directory = == app == The ''app'' folder holds all logic for the service, the files inside this..."

New page

= Overview =

Standard file and folder for each backend microservice.

= Root directory =

== app ==

The ''app'' folder holds all logic for the service, the files inside this folder are a single serverless/node project.

== config ==

The ''config'' folder has files that are shared by both app and resource projects, most per-deploy settings are saved here.

== resource ==

The ''resource'' folder is a stand alone serverless/node project that deploys resources that should not change often, deploying as a separate stack gives some protection against damaging resources such as databases when making regular changes to logic.

== files ==

=== .gitignore ===

Global .gitignore for entire git project

=== COPYING ===

Standard license information

=== README.md ===

Landing page when viewing the project on repository host

= app project =

== initial_setup ==

Offers a method to setup an initial instance of the service.

=== config.js ===

Configurable details that will be implemented during initial setup

=== initialSetup.js ===

Logic that performs the initial setup, is deployed as a Lambda function and expected to be run once after deployment, after invoked it can be removed or disabled on AWS

== src ==

Per service logic

=== lib ===

The lib folder stores functions that are used by multiple Lambda functions

== __test__ ==

Holds code that executes local unit tests

= resource project =

...