notes

About The Project

This is a backend application for a notes app, developed using Go. The API supports both REST and GraphQL communication. While the application is designed to be simple in terms of business logic, it serves as a robust example of a Go project structure. It is intended to be a solid starting point for more complex applications.

Built With

• Programming language - Go
• Http server - net/http
• GraphQL library - gqlgen
• Database - PostgreSQL
• Cache - Redis

How to test

1. Install Postman from here.
2. Download the api postman collection here

Documentation

• Swagger Documentation

Prerequisites

1. Install Go 1.22.4
2. Install Docker
3. Install direnv to export the environment variables. (only for development)

Setup for development

1. Clone the repo

   git clone https://github.com/daniarmas/notes.git
   

2. Install Go dependencies

   go mod download
   

3. Deploy docker compose file

   docker compose -f deploy/docker-compose-dev.yaml up -d
   

4. Run direnv command to approve his content

   direnv allow
   

5. Create the .envrc file with the env vars in example.env

6. cp example.env .envrc
   

7. Create the database tables

   go run main.go create database
   

8. Seed the database. This seed the database for test purpose

   go run main.go create seed
   

9. Configure an object storage service compatible with the Amazon S3 API. DigitalOcean Spaces was used in the development. Ensure you update the access key, secret key and bucket name in the .envrc file.
10. Run the app

go run main.go run

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Contact information

Acknowledgments

• Sqlc
• PostgreSQL Driver
• Library for CLI apps
• Redis client