Handles core functionality of elek.io Projects like file IO and version control as well as providing schemas and types.
|-- src
| |-- api
| | Exports a local API that allows reading Project data
| | mainly for development of websites or apps on the same device.
| |-- error
| | Different classes extending Error.
| |-- schema
| | Zod schemas for validation and types.
| |-- service
| | Contains CRUD logic that does file-io as well as utility functions.
| | The methods are mostly used as endpoints
| | so their input is validated against our zod schemas.
| |-- test
| | Additional files and utility functions only used for testing.
| |-- util
| | Utility functions like path generation.
| |-- index.browser.ts
| | Exports all schemas and types as well as the ElekIoCore type
| | but does not export the ElekIoCore main class,
| | since it is not actually usable in a browser environment.
| |-- index.node.ts
| | Exports the ElekIoCore main class which makes the services and API
| | endpoints accessible as well as schemas and utility functions.
|-- Project - e.g. "Website"
| |-- Collection - e.g. "Blog"
| | Contains Field definitions all Entries and Values of the Collection must follow.
| | |-- Entry - e.g "Post"
| | | |-- Value - e.g for a post's title: "Quarterly results 7% higher than expected"
| | | |-- Asset - a reference to a previously added Asset like image, PDF or ZIP
| | | |-- Entry - a reference to another Entry e.g. to show the user related posts
Are a container for Collections, Entries, Values and Assets. Think of a folder containing all the relevant files. Projects are version controlled with git, so you can roll back to previous versions of files at any time.
Contains Field definitions (a schema) for possible Values each Entry can or has to have. e.g. for a Blog, it could have the following Field definition for each post / Entry:
- an image that is displayed on top of the post (Asset reference)
- a title to catch users attention (Value)
- content that contains multiple headlines and paragraphs (Value)
- an author that wrote the post (Entry reference)
Each definition like the title, contains additional information for the input Field, that is used to modify it's Value. e.g. the title would be a simple one line input Field, that has a maximum lenght of 150 characters and is required for each post. But the content is a markdown editor to easily add formatting. The image let's the user select a jpeg or png from disk. And the author is a reference to another Collection's Entry, so the user is able to choose one of them.
Contains Values and references that follow the Collection's Field definitions. Why references and not the Assets or Entries themself? To make Values reusable for different Entries and even Collections - so when you update an Asset or Entry, it updates everywhere you've referenced it.
Represent either a single piece of data like the string "How to be successfull in 3 easy steps", a number or a boolean - or a reference to Assets or other Entries.
Are files / blobs like images (png, jpeg etc.), documents (excel sheets etc.), music or a compressed folder. Assets have two files inside the Project's repository - the actual file and additionally a file containing meta information like the size.