{"id":22364110,"url":"https://github.com/11ways/alchemy","last_synced_at":"2025-07-30T15:31:28.962Z","repository":{"id":7326795,"uuid":"8647133","full_name":"11ways/alchemy","owner":"11ways","description":"🧪 A node.js framework","archived":false,"fork":false,"pushed_at":"2024-11-28T13:40:38.000Z","size":3831,"stargazers_count":2,"open_issues_count":8,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-28T14:36:11.499Z","etag":null,"topics":["mvc-framework","nodejs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/11ways.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-03-08T08:44:59.000Z","updated_at":"2024-11-28T13:40:41.000Z","dependencies_parsed_at":"2023-10-02T10:58:39.842Z","dependency_job_id":"a63564ba-7004-47ee-b7c8-9671f9aa0716","html_url":"https://github.com/11ways/alchemy","commit_stats":{"total_commits":1391,"total_committers":6,"mean_commits":"231.83333333333334","dds":0.5758447160316319,"last_synced_commit":"bd493cde132e9d838444a27436b1acbb7c22cd86"},"previous_names":[],"tags_count":57,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/11ways%2Falchemy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/11ways%2Falchemy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/11ways%2Falchemy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/11ways%2Falchemy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/11ways","download_url":"https://codeload.github.com/11ways/alchemy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228153946,"owners_count":17877706,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mvc-framework","nodejs"],"created_at":"2024-12-04T17:18:31.219Z","updated_at":"2024-12-04T17:18:31.932Z","avatar_url":"https://github.com/11ways.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  \u003cimg src=\"https://protoblast.elevenways.be/media/static/alchemy-small.png\" width=30 alt=\"Alchemy logo\"/\u003e\n  \u003cb\u003eAlchemy\u003c/b\u003e\n\u003c/h1\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003c!-- CI - Github Actions --\u003e\n  \u003ca href=\"https://github.com/11ways/alchemy/actions/workflows/unit_test.yaml\"\u003e\n    \u003cimg src=\"https://github.com/11ways/alchemy/actions/workflows/unit_test.yaml/badge.svg\" alt=\"Node.js CI (Linux, MacOS, Windows)\" /\u003e\n  \u003c/a\u003e\n\n  \u003c!-- Coverage - Codecov --\u003e\n  \u003ca href=\"https://codecov.io/gh/11ways/alchemy\"\u003e\n    \u003cimg src=\"https://img.shields.io/codecov/c/github/11ways/alchemy/master.svg\" alt=\"Codecov Coverage report\" /\u003e\n  \u003c/a\u003e\n\n  \u003c!-- DM - Snyk --\u003e\n  \u003ca href=\"https://snyk.io/test/github/11ways/alchemy?targetFile=package.json\"\u003e\n    \u003cimg src=\"https://snyk.io/test/github/11ways/alchemy/badge.svg?targetFile=package.json\" alt=\"Known Vulnerabilities\" /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003c!-- Version - npm --\u003e\n  \u003ca href=\"https://www.npmjs.com/package/alchemymvc\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/alchemymvc.svg\" alt=\"Latest version on npm\" /\u003e\n  \u003c/a\u003e\n\n  \u003c!-- License - MIT --\u003e\n  \u003ca href=\"https://github.com/11ways/alchemy#license\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/license/11ways/alchemy.svg\" alt=\"Project license\" /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\u003cdiv align=\"center\"\u003e\n  A node.js MVC framework\n\u003c/div\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003csub\u003e\n    Coded with ❤️ by \u003ca href=\"#authors\"\u003eEleven Ways\u003c/a\u003e.\n  \u003c/sub\u003e\n\u003c/div\u003e\n\n# Getting started\n\nYou can create a new, empty app by executing this npm command:\n\n```bash\nnpm init alchemy your-app-name\n```\n\nThen `npm install` the package.json contents.\nThis is only `alchemymvc` by default.\n\n# Installation\n\nJust installing the npm package can be done like this:\n\n    $ npm install alchemymvc\n\n# Quick start guide\n\nYou can find all the documentation on [https://alchemy.elevenways.be](https://alchemy.elevenways.be)\n\n\n## Base class\n\nMost Alchemy classes inherit from the `Base` class (which in turn inherits from the `Informer` class, a custom event emitter class)\n\nHere are some important static methods:\n\n### Base.setProperty([key,] getter, setter)\n\nThis will create a property getter/setter on the class. For example:\n\n```js\nMyClass.setProperty(function test_me() {\n  return 'test!'\n});\n```\n\nWill create a property getter called 'test_me' that will always return the string \"test!\"\n\n```js\nvar instance = new MyClass();\ninstance.test_me;\n// »»» \"test!\"\n```\n\n### Base.setMethod([key,] fnc)\n\nThis will add a method to the class. For example:\n\n```js\nMyClass.setMethod(function testMe() {\n  return 'test!'\n});\n```\n\nNow you can call this method:\n\n```js\nvar instance = new MyClass();\ninstance.testMe();\n// »»» \"test!\"\n```\n\n## Models\n\nCreating a server-side model is easy, you need to inherit from the `Alchemy.Model.App`:\n\n```js\nvar Block = Function.inherits('Alchemy.Model.App', function Block(conduit, options) {\n  Block.super.call(this, conduit, options);\n});\n```\n\n### Model schema\n\nAfter that you probably want to define the schema to use, that has to be done in a `constitute` call:\n\n```js\nBlock.constitute(function addFields() {\n\n  // Add a simple unique string field\n  this.addField('name', 'String', {unique: true});\n\n  // Another string field, that is not unique\n  this.addField('title', 'String');\n\n  // Longer piece of text\n  this.addField('content', 'Text');\n});\n```\n\nBy default 3 fields are already added to the schema:\n\n* **_id**: An ObjectID field\n* **created**: A datetime field with the creation date\n* **updated**: A datetime field that gets updated whenever the record is saved\n\n## Authors\n\nAlchemyMVC is developed at [Eleven Ways](https://www.elevenways.be/), a team of [IAAP Certified Accessibility Specialists](https://www.accessibilityassociation.org/).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F11ways%2Falchemy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F11ways%2Falchemy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F11ways%2Falchemy/lists"}