Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/batnoter/batnoter-api
The API backend for BatNoter. Built with Golang
https://github.com/batnoter/batnoter-api
container-ready contributions-welcome gin github github-oauth2 go golang gomock gorm markdown notes notes-api
Last synced: 3 months ago
JSON representation
The API backend for BatNoter. Built with Golang
- Host: GitHub
- URL: https://github.com/batnoter/batnoter-api
- Owner: batnoter
- License: mit
- Created: 2022-05-24T08:45:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-06-23T13:56:31.000Z (over 2 years ago)
- Last Synced: 2024-10-31T11:51:32.750Z (3 months ago)
- Topics: container-ready, contributions-welcome, gin, github, github-oauth2, go, golang, gomock, gorm, markdown, notes, notes-api
- Language: Go
- Homepage: https://api.batnoter.com
- Size: 168 KB
- Stars: 48
- Watchers: 3
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## BatNoter API Module
[](https://github.com/batnoter/batnoter-api/actions?query=branch%3Amain)
[](https://codecov.io/gh/batnoter/batnoter-api)
[](https://www.codacy.com/gh/batnoter/batnoter-api/dashboard?utm_source=github.com&utm_medium=referral&utm_content=batnoter/batnoter-api&utm_campaign=Badge_Grade)
This is the api service of batnoter application built with golang.
It exposes ReST endpoints to access and manage markdown notes from user's git repository. Currently it only supports github repository for storing & managing notes.
### Local Development Setup
#### Prerequisites
* Go version `1.18` or above
* Docker Desktop
#### Start postgres database container
Below commands use docker to start the database container.
```shell
make network
make postgres
make createdb
```
#### Create configuration file from template
The `config.yaml` is the configuration template file containing default config values.
```shell
cp config.yaml .config.yaml
```
Application uses `.config.yaml` file to get the config values. Please update placeholder-values from this config file to the actual ones.
#### Start the server
Make sure that the `.config.yaml` file is configured correctly & database container is up & running.
Then run the below commands to setup the db schema and start the web server.
```shell
go run main.go migrateup
go run main.go serve
```
This will start the server on port specified in `.config.yaml` file. You can now access the api endpoints.
#### Run tests
```shell
go test -v -cover ./...
```
This will execute all the tests and also prints the code coverage percentage.
### Contribution Guidelines
> Every Contribution Makes a Difference
Read the [Contribution Guidelines](CONTRIBUTING.md) before you contribute.
### Special Thanks
[](https://jb.gg/OpenSourceSupport)