https://github.com/mrinjamul/gnote

A note taking web based application
https://github.com/mrinjamul/gnote

api cli command-line gin go note note-taking productivity utilities

Last synced: 19 days ago
JSON representation

A note taking web based application

• Host: GitHub
• URL: https://github.com/mrinjamul/gnote
• Owner: mrinjamul
• License: mit
• Created: 2022-03-01T05:01:42.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-07-16T11:32:38.000Z (over 2 years ago)
• Last Synced: 2024-10-16T20:11:04.444Z (2 months ago)
• Topics: api, cli, command-line, gin, go, note, note-taking, productivity, utilities
• Language: Go
• Homepage: https://note.mrinjamul.in
• Size: 613 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  
gnote

  


    A notetaking and snippet sharing web based application.

  



hosted at [note.mrinjamul.in](https://note.mrinjamul.in).

Note: Work in progress.

## Requirements

- [Golang](https://golang.org/dl/)

- [Docker](https://docs.docker.com/get-docker/) (Optional but recommended)

- [Postgresql](https://www.postgresql.org/download/) (**Only if you are not using `docker`**)

### Development

To get started, you can clone the repository and run the following commands:

```bash

git clone https://github.com/mrinjamul/gnote.git

```

To install the dependencies, run the following commands:

```bash

cd gnote

go mod download

```

Copy environment variables file and replace the values with your own.

```bash

cp .env.example .env

```

To run the application, run the following commands:

```bash

export $(cat .env | xargs)

make dev

./gnote

```

To build the application (production), run the following commands:

```bash

make

export $(cat .env | xargs)

./gnote

```

### License

- Backend is open sourced under the [MIT license](LICENSE)

- CLI is open sourced under the [Apache 2 license](cmd/gnote/LICENSE)