notes

README

Notes API

Explore the api docs »

About The Project

This is a RESTful API for a notes application, developed using Go. Although the API is designed to be simple in terms of business logic, it serves as a robust example of a Go project implementation. It is intended to be a solid starting point for more complex applications.

Features

• Basic Authentication
• Notes Managment
• File attachments
• Google Sign-In

Built With

• Programming language - Go
• Http server - net/http
• Database - CockroachDB
• Cache - Redis

How to test

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

Documentation

• Swagger Documentation

Installation

1. Install Go 1.22.4 https://go.dev/doc/install
2. Clone the repo

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

3. Install Go dependencies

   go mod download
   

4. Install Docker https://docs.docker.com/desktop/
5. Deploy docker compose file

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

6. Create the database tables

   go run main.go create database
   

7. Seed the database. This create the users in the database for test purpose

   go run main.go create seed
   

8. Run the app

   go run main.go run
   

(back to top)

License

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

(back to top)

Contact

Linkedin

(back to top)

Acknowledgments

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

(back to top)