Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sbshah97/surrealdb-go-starter-project
SurrealDB Starter Project using Go
https://github.com/sbshah97/surrealdb-go-starter-project
Last synced: about 6 hours ago
JSON representation
SurrealDB Starter Project using Go
- Host: GitHub
- URL: https://github.com/sbshah97/surrealdb-go-starter-project
- Owner: sbshah97
- License: apache-2.0
- Created: 2023-10-17T17:49:55.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-12T22:52:15.000Z (6 months ago)
- Last Synced: 2024-08-01T22:43:14.476Z (3 months ago)
- Language: Go
- Size: 89.8 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-surreal - SurrealDB + Go Driver Starter - [Salman Shah](https://github.com/sbshah97). (Starter Kits)
README
# 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:
```bash
docker compose up -d
```
```bash
docker compose stop # Pauses the container
docker compose down # Tears down the container, wiping data
```
### MacOS
```zsh
brew install surrealdb/tap/surreal
```
```zsh
make dbrun
```
Now, you can start coding and developing your Go project.
## Install Golangci
Use the following [golang-ci link](https://golangci-lint.run/usage/install/) 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.
```bash
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:
```bash
pip install pre-commit
```
### Install pre-commit hooks
Run the following command to install the pre-commit hook:
```bash
pre-commit install
```
### Running pre-commit manually
You can run pre-commit manually on all files with:
```bash
pre-commit run --all-files
```
## Project Roadmap
TODO: Move to Epic / Wiki soon
- [x] Basic Main function
- [x] Integrate Go HTTP Router
- [x] Integrate simple GET/POST/PUT/DELETE event
- [ ] Integrate DB logic with HTTP Methods
- [x] Integrate GET Method
- [x] Integrate POST Method
- [ ] Integrate PUT Method
- [ ] Integrate DELETE Method
- [ ] Add data to DB
- [x] Add logging