joelseq / linkstowr-api

Backend API for the LinkStowr web app, chrome extension and obsidian plugin

Home Page:https://linkstowr.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

LinkStowr API

GitHub release (latest SemVer) Build status

API for the LinkStowr web app, chrome extension and obsidian plugin.

Developing

This project uses SurrealDB as the database. Take a look at their docs for instructions on how to install it.

Start the database using the script file:

./init_db.sh

This will run a local version of SurrealDB and write its data to the "data" directory.

The back end uses Shuttle to simplify the development and deployment process. This requires installing the cargo-shuttle CLI.

To run the server locally:

cargo shuttle run

To run the server in watch mode:

cargo watch -q -c -w src/ -x "shuttle run"

Resources

These are some resources that I found helpful while learning how to create a Rust backend:

About

Backend API for the LinkStowr web app, chrome extension and obsidian plugin

https://linkstowr.com/


Languages

Language:Rust 97.9%Language:Dockerfile 1.9%Language:Shell 0.2%