dsql-admin/dsql-app/.local_dist/server/pages/docs/quick-start.json

1 line
8.7 KiB
JSON
Raw Normal View History

2024-12-08 19:56:57 +00:00
{"pageProps":{"user":null,"pages":[{"id":8,"title":"Getting Started","slug":"getting-started","level":1,"parent_id":null},{"id":9,"title":"Getting Started","slug":"getting-started","level":2,"parent_id":3},{"id":2,"title":"Quick Start","slug":"quick-start","level":1,"parent_id":null},{"id":3,"title":"GUI Reference","slug":"gui-reference","level":1,"parent_id":null},{"id":4,"title":"API Reference","slug":"api-reference","level":1,"parent_id":null},{"id":10,"title":"Get","slug":"get","level":2,"parent_id":4},{"id":12,"title":"Database Reference","slug":"database-reference","level":1,"parent_id":null},{"id":11,"title":"Post","slug":"post","level":2,"parent_id":4},{"id":13,"title":"Data types","slug":"data-types","level":2,"parent_id":12},{"id":14,"title":"Querying Data","slug":"querying-data","level":2,"parent_id":12},{"id":15,"title":"Upload Media","slug":"upload-media","level":2,"parent_id":3}],"targetPage":{"title":"Quick Start","slug":"quick-start","description":"<p>Start saving and retrieving data now. Set up and start deploying in minutes.</p>","content":"<h2>Starting up your Datasquirel instance</h2><p>To get started with datasquirel you need an account online. The datasquirel npm module will hit this account via out API integration using your API credentials. Without an account, you cannout query any data on our API. Follow these steps to create an account:</p><h3>1. Create Account</h3><p>Create a free account <a href=\"https://datasquirel.com/create-account\">here</a></p><p><img src=\"https://static.datasquirel.com/images/user-images/user-2/docs/create-account.png\" width=\"800\" height=\"578\" /></p><p><br /></p><h3>2. Create Database</h3><p>Navigate to your <a href=\"https://datasquirel.com/admin\">Dashboard</a> or <a href=\"https://datasquirel.com/admin/databases\">Databases page</a>. Click the \"Add Database\" button to add a new database.</p><p><img src=\"https://static.datasquirel.com/images/user-images/user-2/docs/screencapture-localhost-7070-admin-2023-07-16-13_35_04.png\" width=\"800\" height=\"424\" /></p><p>On the next screen that appears, fill in the form and add a database image if you wish. Click on \"Create Database\" to add the new database</p><p><img src=\"https://static.datasquirel.com/images/user-images/user-2/docs/screencapture-localhost-7070-admin-databases-add-database-2023-07-17-11_01_28.png\" width=\"800\" height=\"374\" /></p><p>Creating a new database takes you to the database page. This page allows you to import a pre-existing database using an SQL export file, or create a new table inside the newly-formed database. More operations for your database can be found in the database dropdown on the top left, or the \"more\" dropdown on the top right.</p><p><img src=\"https://static.datasquirel.com/images/user-images/user-2/docs/screencapture-localhost-7070-admin-databases-test-2023-07-17-11_09_52.png\" width=\"800\" height=\"374\" /></p><h3>3. Add a table</h3><p>Databases consists of Tables: each with fields(or columns) and entries(or rows). Select a database from your database list to access the single database pages. Click on \"Add Table\" and fill in the new table form.</p><p><img src=\"https://static.datasquirel.com/images/user-images/user-2/docs/add-table-form.png\" width=\"800\" height=\"797\" /></p><p>On each table form you have access to the table fields(or column titles). Each field contains a few options:</p><ul><li><strong>Field Name</strong>: Name of field(or column title)</li><li><strong>Data Type</strong>: type of data to be stored on that field: <a class=\"inline\" href=\"docs/db-reference/data-types\">See All Datatypes</a></li><li><strong>Required</strong>: Choose whether the field must have a value or not</li><li><strong>Default Value</strong>: Default value of field in the case no value is entered.</li><li><strong>More:</strong> The \"More\" button contains options for encryption and foreign keys</li></ul><p>After these fields are filled, click \"Add Field\". Add as much field as you need. These fields serve as column titles for your table.</p><p><img src=\"https://stat