Creating a DataFakery Project

Step1: Creating a project

Creating a new project with DataFakery is quick and easy. Simply click the large '+' button in your sidebar and select 'New Project' from the menu that appears.

Step 1: Define a Project Name

Enter the Project Name: Click on the text box labeled "New Project" and type in the name of your new project. This name will help you identify your project later.

Step 2: Choose Your Data Source

You have two options for defining the data source for your project:

1. Use Existing Data Source

   • Select this option if you want to use data from an existing database such as MS SQL Server, MySQL, or PostgreSQL.

2. Create Data from Scratch

   • Select this option if you want to create a new dataset from scratch and export it to a CSV file. This option is useful if you do not have an existing database and wish to generate new data.

Step 2: Configure Data Source Settings

In this step, you will configure the data source settings for your DataFakery project. Follow these instructions to set up your data source correctly.

Select Your Data Source Type

1. Choose the Database Type: On the left side of the form, select the type of database you are connecting to. Options include:

   • SQL Server

   • MySQL

   • PostgreSQL

Configure Common Settings

1. Connection Name: Enter a name for your database connection in the "Connection Name" field. This name will help you identify this specific connection later.

2. Server: Enter the server address where your database is hosted.

3. Database: Enter the name of the database you wish to connect to.

Configure Authentication

1. Authentication: Choose the authentication method from the dropdown menu. Options typically include:

   • Windows Authentication

   • SQL Server Authentication (or equivalent for MySQL/PostgreSQL)

2. Username and Password: If required by your authentication method, enter the username and password needed to access the database.

Additional Settings

• Advanced: Click on the "Advanced" tab to configure any advanced settings for your database connection.

• Additional Parameters: Click on the "Additional Parameters" tab to set any additional parameters that your connection might require.

Test Your Connection

Click the "Test connection" button to ensure that the provided details are correct and that you can successfully connect to the database.

Use Docker Container (Optional)

If you wish to use a Docker container as a data source, click on "Use Docker Container." The displayed window will show you all available Docker instances on your machine. You can select an available Docker container if it's a supported data source such as PostgreSQL, MSSQL, or MySQL. DataFakery will try to extract the database connection string based on the metadata of the Docker container. Simply click on "Use as Data Source" to proceed. See Docker Integration for further details.

Step 3: Set Project Mode

In this step, you will configure the appearance and theme settings for your DataFakery project. Follow these instructions to customize your project environment.

Appearance / View

Simple Mode:

• Select "Simple" if you prefer a streamlined interface suitable for most use cases. This mode is recommended for users who want an easy and straightforward experience.

Expert Mode:

• Select "Expert" if you need access to advanced features and configurations. This mode is ideal for users with more complex requirements or those who are familiar with detailed settings.

Dark / Light Theme Preference

Dark Theme:

• Choose "Dark Theme" for a dark interface that is easier on the eyes in low-light environments.

Light Theme:

• Choose "Light Theme" for a bright and clear interface that is suitable for well-lit environments.

Note: You can switch between different themes, skins, and palettes later if needed.

Step 4: Save your Project

To finish the project creation, click on "Finish" and save the file. You have just completed the wizard, and your project will now be loaded.

Additional Tips

• Ensure the project name is unique and descriptive to avoid confusion with other projects.

• If you are using an existing data source, make sure you have the necessary credentials and permissions to access the database.

By following these steps, you will successfully initiate a new project in the DataFakery Project Wizard. Continue through the subsequent steps of the wizard to configure and finalize your project settings.

Happy data faking!