Adimac93 / bibrus

Bibrus approach no. 2

Bibrus

Bibrus approach no. 2

Commit structure

? - optional
* - zero or more
Name:
<category><project>?<!/?>?(breaking change/untested): <present tense>
Description:
<+/-/~>* (add/remove/comment)

Use backticks (`text`) when referring to code (e.g.trait, counter, String )

Breaking changes have to be tested!

Categories

• fix - fixing unwanted behaviour
• perf - performance, optimization
• docs - document, documentation
• feat - feature
• refactor - changing structure but not functionality
• format - only text, visual changes
• init - only for initialization purposes
• test - testing something or adding tests

Environment

Currently we are using Doppler to keep our secrets and app configuration in sync and secure across devices.

Command line interface guide here

Database

Prerequsities

You'll need to download some tooling first.

Details about postgresql installation:

• mac
• windows

Details about libpq installation:

• Mac brew: brew install libpq postgresql
• windows
• windows error

Connection

To use databse locally you'll need to specify DATABASE_URL environnmental variable in .env file.

# Example .env file
DATABASE_URL="postgresql://postgres@localhost:5432/bibrus"

Bit.io

Online database is hosted on bit.io and checking in it's great if you would like to check out information like configuration, ussage, data and more.

Doppler

If you are connecting remotely you only need to use DATABASE_URL specified in Doppler with environment of your choice (e.g. Development, Staging, Production; see differences here).

CLI

To use ORM (object relational mapping) that's featured with Diesel you'll need to setup diesel-cli.

If everything mentioned before is set up correctly: cargo install diesel_cli --no-default-features --features "postgres" would not output any errors.

Useful tools

• Administration tools:

  • Recommended: All in one, postgres included: PgAdmin
  • JetBrains DataGrip
  • PostgreSQL interactive terminal psql

• Database servers:

  • Raw PostgreSQL server
  • Only mac app

Resources

• Axum
  • docs.rs
  • examples
• Tokio
  • docs.rs
  • tokio.rs
• Diesel
  • docs.rs
  • guides

Files

.keep

.keep files are sometimes used by developers who use Git. Git only tracks files, which means it cannot track empty directories. By sticking a .keep file into the (no-longer) empty directory, the directory has some kind of representation in the Git repository. The name .keep is just a convention. It has no meaning to Git itself.

.env

Text configuration file for controlling your local Applications environment constants.

Acceptable langs

• Rust
• TypeScript