When you first open the desktop app, the home screen opens right away, without a sign-in screen. You can create and use local projects without an account, and sign in later when you want to share with your team or use several devices. What differs between signed in and not signed in is explained in Sign-in and project types.
When you first open the web app, the sign-in screen opens. After you sign in you see the same home screen, and the projects you create are account projects. Signing up and signing in on the web are explained in Sign-up and sign-in.
What you see first
| No. | Name | Description |
|---|---|---|
| 1 | App menu | Menus for Database Project (Create Database Project..., Database Project Management and Recent Projects), Data Dictionary and Template Pack, plus Check for Updates in the installed desktop app. The app version you are using is shown next to the logo. Described in App menu, top bar and status bar. |
| 2 | Work tab strip | Open projects and management screens are placed here as tabs. Open a recent project with the Open project button. See Work tabs. |
| 3 | Shortcut cards | The Create New Database Project card, the Create Data Dictionary card and the Create New Template Pack card. |
| 4 | List | Projects, data dictionaries and template packs are shown as cards. It is empty at first. See Home. |
| 5 | User indicator | When you are not signed in, your operating system user name and a LOCAL label are shown. Click it for the My Page item and the Sign In item. |
| 6 | Bug report | The Report a bug button. You can send a report without signing in. See Bug report. |
| 7 | Notifications | Notices sent to all users. |
On the first start, the release notes for the installed version may appear first. Close the window to see the home screen.
Creating your first local project
- Click the Create New Database Project card on the home screen. You can also open it with the item.
- Read the notice at the top of the dialog (1). When you are not signed in, You are not signed in — this project will be stored only on this device. Sign in to create account projects. is shown and the project is created as a local project.
- Enter a name in the Project Name field (2).
- To start with example tables, select the Create Sample ERD (classicmodels) option (3) and choose a DBMS in the Select DBMS field that appears to the right (4). If you do not select it, an empty project without connections is created.
- Click the Create button (5). A Project created notification appears and the project screen opens.
What happens after the project opens depends on what you chose.
| What you chose | After the project opens |
|---|---|
| Sample ERD | An ERD with a connection for the chosen DBMS and example tables (customers, orders, products, employees and others) opens, and the Connection Setup dialog appears. Click the OK button to open the connection dialog and enter the database connection details. Click the Cancel button to draw the ERD without connection details and enter them later. |
| Empty project | The project screen opens without connections. Add a connection in the object explorer. See Create and edit a connection. |
To follow the whole sequence of connecting to a database, building an ERD and applying it, see Design your first ERD and apply it to a database.
Signing in
Once you sign in, you can create account projects, share them with your team and open them on several devices. The desktop app signs you in through your browser and then returns to the app.
- Click the user indicator at the right of the header, then click the Sign In item. The sign-in screen opens.
- Click the Sign In with Browser button (2). The NeoSQL sign-in page opens in your default browser, and the app switches to a screen that waits for you to sign in.
- Sign in in the browser. When you are done, the browser opens the NeoSQL app. If the browser asks whether to open the app, allow it.
- The app returns to the home screen. Your account name and plan are shown at the right of the header.
- If you do not have an account, click the Create Account link (4). Sign up in the browser, then sign in with the Sign In with Browser button again.
- If you do not see the browser tab, click the Go back and try again link on the waiting screen and try again.
- To go back without signing in, click the Continue without account link (3).
- The language selector (1) changes the display language of this device. See 'Changing the language' below.
After you sign in, the following changes.
- Account projects appear in the list on the home screen as well. Local projects get a Local label.
- The new project dialog gets a Project Type option, where you choose between the Account button and the Local button. The Account button is selected at first.
- Local projects you already created stay local. You cannot change a project's type later.
- The desktop app keeps its own sign-in, separate from the browser. Signing out of the desktop app leaves you signed in in the browser.
Signing out
- Click your account name at the right of the header, then click the Sign Out item. The item does the same.
- If there are unsaved changes, you are asked whether to save them first.
- The tabs of open account projects and management screens close, and you return to the home screen without being signed in.
After you sign out, local projects stay and you can keep using them; the tabs of open local projects do not close. Account projects stay on the NeoSQL server, and when you sign in again with the same account, they come back to the list together with the tabs that were closed. The display language returns to this device's language. Signing out of the web app takes you to the sign-in screen.
Changing the language
The app's display language is Korean or English. On the first start, it is Korean if your operating system's language is Korean, and English otherwise.
| State | Where to change it | What it applies to |
|---|---|---|
| Sign-in screen | The language selector at the top right | Saved as this device's language. |
| Not signed in | The Device Settings section of the screen | Choose the Language field and the Timezone field and click the Save button to save them on this device. |
| Signed in | The Profile section of the same screen | Saved as your account's language. While you are signed in it takes precedence over this device's language; when you sign out, the device's language returns. |
To open the My Page screen, click the user indicator at the right of the header, then click the My Page item.
Where to go next
- Web and desktop: what works and what does not in each app.
- Sign-in and project types: the difference between local and account projects.
- Design your first ERD and apply it to a database: the steps to build an ERD in your first project and apply it to a database.
- Work tabs: how to keep several projects open as tabs and switch between them.