✨ Org Note backend.

Introduction

This project is part of Org Note project. It is a backend part based on the GO fiber framework.

Connected links

• Swagger schema
• Main repo
• Org Note frontend
• About Zettelkasten approach
• GO fiber framework
• GO swagger library

Install

Environment variables

• MONGO_USERNAME
• MONGO_URL
• MONGO_PASSWORD
• MONGO_PORT
• APP_ADDRESS - Current application address
• GITHUB_ID - github id for oauth
• GITHUB_SECRET - github secret for oauth
• BACKEND_DOMAIN - backend domain address
• BACKEND_SCHEMA - backend schema (http/https)
• BACKEND_PORT - backend port
• CLIENT_ADDRESS - client address for oauth redirect
• ACCESS_CHECK_URL - url address for checking access to the backend. For self hosted systems this values should not be provided
• ACCESS_CHECK_TOKEN - Auth token for request to ACCESS_CHECK_URL. Will be added into Authorization header

Local development

Make sure that you have

git clone [email protected]:Artawower/orgnote-backend.git && cd orgnote-backend

Make sure the correct .env file is in the `orgnote-client’ directory.

docker-compose -f docker-compose.db.yaml -f docker-compose.dev.yaml up --build

Swagger

The swagger path is {{HOST}}/v1/swagger/index.html for example: http://localhost:8000/v1/swagger/index.html

🍩 Contribute guide

Any contribution is very much appreciated! Please read the style guide before contributing to avoid misunderstandings!

I would also appreciate it if you would consider becoming my patron

Access checker

What is an access checker? It is an external web service accessible by ACCESS_CHECK_URL. It is used to verify access to the backend. For self-hosted systems, this value should not be provided unless you have the service implemented. In this case, anyone can access the backend.

This backend service should provide next endpoints:

• /api/subscription-info - information about subscription

{
  "email": "string",
  "spaceLimit": "bytes",
  "isActive": "boolean"
}