gnote

README

gnote

A notetaking and snippet sharing web based application.

hosted at note.mrinjamul.in.

Note: Work in progress.

Requirements

• Golang
• Docker (Optional but recommended)
• Postgresql (Only if you are not using docker)

Development

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

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

To install the dependencies, run the following commands:

cd gnote
go mod download

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

cp .env.example .env

To run the application, run the following commands:

export $(cat .env | xargs)
make dev
./gnote

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

make
export $(cat .env | xargs)
./gnote

License

• Backend is open sourced under the MIT license
• CLI is open sourced under the Apache 2 license