SurrealDB Go Starter Project

Welcome to the SurrealDB Go Starter Project, a solid foundation for your Go projects powered by SurrealDB.

Getting Started

To start a new Go project using this template, you can clone or download this repository.

Development

After you have cloned the repository, you need to set up SurrealDB.

TODO: Using Docker

We recommend using Docker, but you can also install SurrealDB directly on your machine.

To set up a Docker container for SurrealDB, run the following command:

docker compose up -d

docker compose stop # Pauses the container
docker compose down # Tears down the container, wiping data

MacOS

brew install surrealdb/tap/surreal

make dbrun

Now, you can start coding and developing your Go project.

Install Golangci

Use the following golang-ci link to install it for your setup

Running golang-ci

Run make lint

Running tests

Run make test

Running the application

Run make run

Sample Run To Db

Description

• This command retrieves user data from the application. Replace Ishrat and Shah with your desired input.

curl --location 'http://0.0.0.0:8080/users' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Ishrat",
    "surname": "Shah"
}'

Contributing

This project is built for Hacktoberfest 2023, and anyone is welcome to contribute or offer suggestions on how to enhance this template for Go development with SurrealDB.

You are encouraged to open pull requests or issues, and I'll review them as soon as possible.

Happy coding with SurrealDB for Go!

Pre-commit Hook Setup

To ensure code quality and that all tests pass before committing, we use pre-commit hooks.

Install pre-commit

First, install pre-commit using pip:

pip install pre-commit

Install pre-commit hooks

Run the following command to install the pre-commit hook:

pre-commit install

Running pre-commit manually

You can run pre-commit manually on all files with:

pre-commit run --all-files

Project Roadmap

TODO: Move to Epic / Wiki soon

• Basic Main function
• Integrate Go HTTP Router
• Integrate simple GET/POST/PUT/DELETE event
• Integrate DB logic with HTTP Methods
  • Integrate GET Method
  • Integrate POST Method
  • Integrate PUT Method
  • Integrate DELETE Method
• Add data to DB
• Add logging