Starting your Neurelo Project
Last updated
Last updated
Projects are applications (software/workload) that developers build and run with Neurelo. This is the primary “working” entity where all things start inside Neurelo. A project exists inside an Organization and has its own set of entities such as data definitions, environments, dashboards, data sources, etc. There is no limit to the number of projects users can create in Neurelo.
To begin setting up your new project in Neurelo, follow these simple steps:
Access Your Neurelo Dashboard: After signing in to your Neurelo account, you will be directed to your Neurelo Dashboard. This is your central hub for managing your projects.
Start a New Project:
Look for an orange button on the Dashboard with a + icon and the word "New" inside it. This button is designed for creating new projects.
Initiate Project Creation: Click on this orange "+ New" button. This action will launch the process for setting up a new project in Neurelo.
As part of creation of a new project, please provide the following information:
Organization Name: The organization name associated with your account will be automatically filled in. This helps in categorizing your project under the correct organizational umbrella in Neurelo.
Name Your Project: Enter a distinctive name for your project. This name should reflect the essence or purpose of the project for easy identification.
Select the Database Engine: For your project, choose any one of the supported databases from the available options. This selection is crucial as it determines the database technology your project will utilize.
Migrations (Optional): Neurelo supports a feature (in preview) to automatically generate an initial set of schema migrations to correspond with the schema (data model) changes. This is enabled by default for the supported relational databases - PostgreSQL and MySQL. If this setting is enabled, schema migrations are generated as schema changes are made. There is additionally also a feature to apply (also in preview mode) these migrations. For non-relational databases such as MongoDB, this setting is not supported.
Neurelo Schema Migrations is currently a feature is currently in preview and not intended for production use. Use with caution and provide feedback to help us improve.
Note - The Migrations setting is a one-way toggle, and can't be re-enabled once it's disabled (either during project creation, or subsequently from under project settings)
Language Stack Preference (Optional): Choose the programming language you will be using for your project. This tailors (future) your Neurelo project environment to your preferred programming language such as providing language specific SDK, and for API examples.
Project Description (Optional): There is an optional 'Description' field where you can provide a brief summary of your project. Although optional, this can be helpful for future reference or for team members to understand the project's purpose at a glance in the overview page.
Use Remote Git Repository (Optional): When creating a new project in Neurelo, you can choose to use your own git repository for the Definitions (Schema, Migrations, Custom APIs, etc.) in your project instead in Neurelo's versioning system. Please refer to this guide for details on connecting and using a remote git repo in your project.
Create the Project: Finally, click on the "Create" button to finalize the creation of your new Neurelo project. This action will initialize your project with the configuration you have specified.
After you click on create, you will see the following screen and the next steps for your project.
You can start with one of 3 options:
Quick Start guide (Recommended): This is a step-by-step guide to help users with setting up and onboarding their new projects. This flow is recommended for all users new to Neurelo.
Introspection (Advanced): For advanced users of Neurelo, who are familiar and comfortable with the platform, this option enables users to start a project with definitions from an existing data source. Choose this option if you want to start from an existing data source. It’s ideal for projects where a database already exists and you want Neurelo to adapt to its current schema.
Empty Project (Advanced): For advanced users of Neurelo, who are familiar and comfortable with the platform, this option enables users to start a project from scratch and build definitions in Neurelo.
By completing these steps, your Neurelo project is now initialized and ready for your next steps. You can begin integrating your database and leveraging the powerful features offered by Neurelo for efficient data management and API generation.
