You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- 🪄 AI Engine - Fake data are generated through an AI engine.
15
15
- 🔆 Flexible scheme - User can define a schema similar to mongoose, using primitive types.
16
16
- 🌏 Localization - Data are translated into 5 languages: 🇬🇧, 🇮🇹, 🇪🇸, 🇩🇪, 🇫🇷
17
17
- 🏦 Data store - Large amount of data stored in our system.
18
18
- 💾 Save schema - User can save a schema to use it at a later time.
19
19
20
-
## Install
20
+
## 📦 Install
21
21
22
22
```bash
23
23
npm install magikfake@beta
@@ -31,7 +31,7 @@ Use it for testing now.
31
31
32
32
---
33
33
34
-
## Introduction
34
+
## 🪄 Introduction
35
35
36
36
Magikfake was created to leverage the power of **AI** in generating data that closely resembles real-world data.
37
37
@@ -51,7 +51,7 @@ For each property defined, the system analyzes the key and type to generate the
51
51
52
52
Unlike other fake data generation systems, Magikfake simplifies schema definition by allowing the user to assign a **primitive** type (**string**, **number**, **date**, **boolean**, **objectId**, etc...) to each property, without the need for a custom type to obtain the desired value.
53
53
54
-
## Usage and access limits
54
+
## 💻 Usage and access limits
55
55
56
56
To use Magikfake's library for generating fake data, users must obtain an API key. This can be done by registering for an account on the Magikfake website at the following link: https://app.magikfake.com.
57
57
@@ -65,11 +65,11 @@ By obtaining an API key and subscribing to a Magikfake plan, users can quickly a
65
65
| Standard | Available in the official version | Available in the official version |
66
66
| Pro | Available in the official version | Available in the official version |
67
67
68
-
## Try it online
68
+
## ⚡️ Try it online
69
69
70
70
You can try Magikfake online by visiting https://magikfake.com. 1,000,000 tokens are available daily and shared among site users. If you run out of tokens, you can register on the site to take advantage of the 25,000 tokens available monthly.
71
71
72
-
## Supported types and validations
72
+
## 📖 Supported types and validations
73
73
74
74
Magikfake supports a variety of primitive types that can be assigned to the properties in the schema.
75
75
@@ -161,7 +161,7 @@ The types supported are:
161
161
| <prelang="json">{ "users": [ { "id": "objectId", "firstName": "string", "lastName": "string", "age": "number", "isFirstLogin": "boolean", "birthDate": "date" } ] }</pre>or<prelang="json">{ "users": { "type": [{ "id": "objectId", "firstName": "string", "lastName": "string", "age": "number", "isFirstLogin": "boolean", "birthDate": "date" }] } }</pre> | the **users** field of type **array** indicates a list of values of type object, where it is possible to define fields of various types. |
162
162
163
163
164
-
## Schema example
164
+
## 📜 Schema example
165
165
166
166
Here is a schema example with various types of fields:
167
167
@@ -202,7 +202,7 @@ The fake data generated will have this type of structure:
202
202
The result will try to provide a compatibility between the keys and the types, this to make the data as truthful as possible.
When using the methods provided by the Magikfake library, it is possible that an exception may be raised. If this occurs, the user will receive an error message indicating the nature of the issue.
674
674
@@ -682,7 +682,7 @@ Some of the errors that may be encountered include:
682
682
In any of these cases, the user should review their code and make any necessary corrections or updates to address the error. By working with the Magikfake library and handling errors appropriately, users can generate high-quality, realistic fake data for a variety of purposes.
683
683
684
684
685
-
## Supports and issue
685
+
## 🆘 Supports and issue
686
686
687
687
If you need support you can contact us at the following email: [email protected].
0 commit comments