/NoteIt-SurrealDb-starter-template

Primary LanguageJavaScript

NoteIt-SurrealDb-starter-template

This repo is a starter kit that sets up front-end and back-end of a simple react and node web-app using surrealdb. It is a basic note taking app that supports adding and deleting notes while fetching data from the local surrealdb instance.

How to setup local development environment:

  • Install surreal from official documentation. Refer here.

  • Start the server using:

    surreal start memory -A --auth --user root --pass root

  • clone the repository and setup back-end and front-end seperately .

  • cd frontend folder use npm install & cd backend and use npm install.

  • type npm start in the frontend dir and node app.js in the backend dir and the terminals should have the following output:

    For frontend

    image

    For backend

    image

Working:

Kooha-2023-11-04-08-28-08

Future Scope:

Many more features can be added such as:

  • User Authentication
  • Multi User Collaboration

Debugging:

Certain console logs and methods provide comments to enable rapid commenting out, checking of other surrealdb methods, and improved debugging of problems encountered when connecting to surrealdb.

Have ideas or Issues?

Feel free to raise the issue or a pr for improving the starter kit :)