Quickly Start with Synngular

Signup

To begin, sign up on the platform by choosing a price plan that best suits your needs. During the registration process, you will be required to verify your account via OTP (One-Time Password) sent to your registered email or phone number. This step ensures account security and authenticity.

Create a New Project

Once your account is verified, log in using your credentials and navigate to the project creation section. Start by entering a project name that best represents your work. Next, provide a brief description outlining the project’s purpose and scope to ensure clarity. Then, select the appropriate runtime technology based on your development requirements. After completing these steps, your project will be successfully created, allowing you to proceed with configuring its components and settings as needed.

Configure Storage

Data storage is a crucial component of any application, providing a structured way to store and manage data. To set up your database, navigate to the Data Store section from the General tab. Here, you can create and configure your data storage based on your project’s needs. Synngular offers multiple database options, including MongoDB, a NoSQL database designed for flexible data structures, MongoDB Atlas, a fully managed cloud-based MongoDB solution, and PostgreSQL, a powerful relational database known for its advanced querying capabilities. If your application requires different types of storage, you can add multiple Data Stores to accommodate various data handling requirements. Additionally, Synngular provides File Stores, enabling you to efficiently manage and store files within your project, ensuring seamless access and organization of application assets.

Define a Data Model

A data model is a conceptual framework that defines how data is structured, stored, and manipulated in a system. It provides a clear representation of data elements, their attributes, and the relationships between them. A well-structured data model serves as the backbone of any data-driven application, ensuring consistency, accuracy, and efficiency in data handling.

Create APIs

APIs (Application Programming Interfaces) allow communication between different parts of your application. To create an API:

1. Enter an API Name – A descriptive name that reflects its functionality.
2. Provide a Description – Explain what the API does and its intended use.
3. API Type – Choose from GET, POST, PUT, DELETE, UPLOAD, DOWNLOAD, and CUSTOM methods based on the API’s functionality.
4. Configure API Settings:
   • Pre-script – Define scripts to run before the API executes.
   • Post-script – Add scripts to run after API execution.
   • Testing – Use built-in tools to test the API response.
   • Documentation – Generate and maintain API documentation for better usability.

Authentication

Security is essential for any application. Set up authentication for your APIs to control access and protect data. You can implement:

• Token-based authentication
• OAuth authentication
• API key authentication

Proper authentication mechanisms prevent unauthorized access and ensure data integrity.

Test APIs

Before deploying your APIs, test them to verify their functionality. Utilize built-in testing tools to:

• Check response times
• Validate request parameters and responses
• Identify and fix any potential issues

After successful testing, your APIs are ready for integration and deployment.