https://github.com/notikapp/v1-api

Note taking web app written in golang and vue 3
https://github.com/notikapp/v1-api

best-practices docker docker-compose full-stack golang makefile migrations postgresql shell-script vue

Last synced: about 2 months ago
JSON representation

Note taking web app written in golang and vue 3

• Host: GitHub
• URL: https://github.com/notikapp/v1-api
• Owner: NotikApp
• License: apache-2.0
• Created: 2023-04-21T12:07:12.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2023-10-16T16:58:00.000Z (over 1 year ago)
• Last Synced: 2025-02-28T16:22:55.436Z (about 2 months ago)
• Topics: best-practices, docker, docker-compose, full-stack, golang, makefile, migrations, postgresql, shell-script, vue
• Language: Go
• Homepage:
• Size: 26 MB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Docker build](https://img.shields.io/github/actions/workflow/status/gavrylenkoIvan/gonotes/docker-image.yml?branch=master&label=docker%20build&logo=github)](https://github.com/gavrylenkoIvan/gonotes/actions?query=workflow)

[![Build Status](https://img.shields.io/github/actions/workflow/status/gavrylenkoIvan/gonotes/go.yml?branch=master&label=build&logo=github)](https://github.com/gavrylenkoIvan/gonotes/actions?query=workflow)

[![Go Report Card](https://goreportcard.com/badge/github.com/gavrylenkoIvan/gonotes)](https://goreportcard.com/report/github.com/gavrylenkoIvan/gonotes)

![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/quality/g/gavrylenkoIvan/gonotes/master)

![GitHub](https://img.shields.io/github/license/gavrylenkoIvan/gonotes)

![GitHub last commit](https://img.shields.io/github/last-commit/gavrylenkoIvan/gonotes)



  



## Note taking app written with golang an vue 3

## Installation

### You can simply install package:

```sh

$ docker pull ghcr.io/gavrylenkoivan/gonotes:master

```

### Or build it locally:

* #### First of all, you will need [docker](https://www.docker.com) dowloaded and started on your pc.

* #### Dowload this repo and open it.

* #### Set environment vars in .env file (those are really informative so I think you won't have any troubles), change enironment in docker-compose file if needed

* #### To start container and init database, run: 

  ```sh

  $ make compose

  ```

* #### Enjoy!

---



  

  ### Screenshots:


  ![alt text](https://github.com/gavrylenkoIvan/gonotes/blob/master/images/main-page.png)

  ![alt text](https://github.com/gavrylenkoIvan/gonotes/blob/master/images/add-note.png)

  ![alt text](https://github.com/gavrylenkoIvan/gonotes/blob/master/images/notes.png)