\n\n \n\n \n\n \n\n \n\n# OOP Data Manager based on Knex and Joi. 🌿\n\n## Introduction\n\nElzeard is a OOP data manager built on top of **[Knex](https://github.com/knex/knex)**, and **[Joi](https://joi.dev/api/?v=17.6.0)** : Two **main** JS libraries when it's about **maintaining code organization** and **securizing** back-end apps.\n\n⚠️ The current version **only** works with a **MySQL/Maria database**\n\n \n\n\n#### 1. Quick intro with **[Knex](https://github.com/knex/knex)** : SQL query builder\n\nBuilding SQL queries is an annoying and redundant task. Knex answers to that problem by greatly symplifying the query building process:\n\nWithout it:\n```sql\nselect * from `users` where `id` = 1\n```\n\nWith it:\n```js\nknex('users').where('id', 1)\n````\n\n \n\n#### 2. Quick intro with **[Joi](https://joi.dev/api/?v=17.6.0)** : Schema descriptor and data validator\n\n- Data formating + treating\n- Rendering errors when needed (ex: POST/PUT req in an API) \n- Defining Model schema \n\nare also an annoying and redundant task.\n\nWith Joi, you can define a schema and generate well-transcripted errors when a data doesn't match its model.\n\nExample:\n```js\nconst schema = Joi.object({\n username: Joi.string().alphanum().min(3).max(30).required(),\n password: Joi.string().pattern(new RegExp('^[a-zA-Z0-9]{3,30}$')),\n access_token: Joi.token()\n birth_year: Joi.number().integer().min(1900).max(2013),\n email: Joi.string().email()\n})\n\nschema.validate({ username: 'abc', birth_year: 1994 });\n// -> { value: { username: 'abc', birth_year: 1994 } }\n\nschema.validate({});\n// -> { value: {}, error: '\"username\" is required' }\n```\n\n \n\n#### 3. Quick intro with **[Joi x SQL](https://github.com/elzeardjs/joixsql)** : Combination of both integrated in Elzeard\n\nTable and column management when iterating on a back-end application is an everyday task that can be removed with automation.\nWe did it, and it is one of the main feature of Elzeard.\n\nQuick example [here](https://github.com/elzeardjs/joixsql/tree/master/example)\n\n\n \n\n \n\n \n\n \n\n \n\n \n\n\n
\n\n \n\n \n\n \n\n \n\n\n\n\n# Get Started\n## Usage\n\n```\nyarn add elzeard\n```\n\n \n\nAfter all your collections have been instanced, set your configuration and make it 'done':\n\n```js\nimport { config } from 'elzeard'\nimport MyCollection1 from './my-collection-1'\nimport MyCollection2 from './my-collection-2'\nimport { startServer } from './server'\n...\n\nconst myCollect1 = new MyCollection1([], {table: 'collection-1'})\nconst myCollect2 = new MyCollection2([], {table: 'collection-2'})\n...\n\nconst initConfig = async () => {\n await config.done()\n ...\n}\n\ninitConfig()\nstartServer()\n```\n\n\n","readmeFilename":"README.md","description":"."}
![\"elzeard\"](\"https://github.com/Fantasim/assets/blob/master/elzeard-baneer.png?raw=true\")
\n \n + Maintanability. | - Code Redundancy. | - Debugging. | + Productivity.\n