njord
A versatile, feature-rich Rust ORM ⛵
File Explorer
Download Latest Version (.zip)- pre-commit
- Build all.run.xml
- Build njord.run.xml
- Build njord_derive.run.xml
- SQLite Integration Tests.run.xml
- Test all.run.xml
- bug_report.md
- config.yml
- design_considerations.md
- feature_request.md
- core.yml
- machete.yml
- release.yml
- dependabot.yml
- FUNDING.yml
- setup.sql
- 2_setup.sql
- mariadb.sql
- mysql.sql
- insert.db
- open.db
- select.db
- select_join.db
- update.db
- delete.rs
- error.rs
- insert.rs
- mod.rs
- select.rs
- update.rs
- util.rs
- delete.rs
- error.rs
- insert.rs
- mod.rs
- select.rs
- update.rs
- util.rs
- delete.rs
- error.rs
- insert.rs
- mod.rs
- select.rs
- update.rs
- util.rs
- delete.rs
- error.rs
- insert.rs
- mod.rs
- select.rs
- update.rs
- util.rs
- delete.rs
- error.rs
- insert.rs
- mod.rs
- select.rs
- update.rs
- util.rs
- column.rs
- condition.rs
- keys.rs
- lib.rs
- query.rs
- table.rs
- util.rs
- delete_test.rs
- insert_test.rs
- mod.rs
- open_test.rs
- select_joins_test.rs
- select_test.rs
- update_test.rs
- delete_test.rs
- insert_test.rs
- mod.rs
- open_test.rs
- select_joins_test.rs
- select_test.rs
- update_test.rs
- delete_test.rs
- insert_test.rs
- mod.rs
- open_test.rs
- select_joins_test.rs
- select_test.rs
- update_test.rs
- delete_test.rs
- insert_test.rs
- mod.rs
- open_test.rs
- select_joins_test.rs
- select_test.rs
- update_test.rs
- delete_test.rs
- insert_test.rs
- mod.rs
- open_test.rs
- raw_test.rs
- select_joins_test.rs
- select_test.rs
- update_test.rs
- Cargo.lock
- Cargo.toml
- command.rs
- main.rs
- migration.rs
- util.rs
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- down.sql
- up.sql
- njord.toml
- Cargo.toml
- lib.rs
- util.rs
- Cargo.toml
- main.rs
- schema.rs
- Cargo.toml
- init.sql
- README.md
- create_tables.sql
- main.rs
- schema.rs
- Cargo.toml
- README.md
- main.rs
- schema.rs
- Cargo.toml
- init.sql
- README.md
- 1_create_tables.sql
- main.rs
- schema.rs
- Cargo.toml
- README.md
- main.rs
- schema.rs
- Cargo.toml
- neo.db
- down.sql
- up.sql
- down.sql
- up.sql
- main.rs
- schema.rs
- Cargo.toml
- generate.sh
- njord.toml
- rollback.sh
- run.sh
- setup.sh
- lib.rs
- Cargo.toml
- .gitignore
- Cargo.lock
- Cargo.toml
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- docker-compose.yml
- LICENSE
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/njord-rs/njord
Downloads the entire project code from GitHub to your computer.
cd njord
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build
Builds and starts all defined containers (server, database, etc.) at once, in the background.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Rust
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Rust (rustup) Installing via rustup also installs cargo.
cargo build --release
Compiles the Rust project.
cargo run
Builds and then immediately runs the program.
If cargo build finishes without errors, it worked. The executable is created under target/.
// repository documentation
Was this content helpful?
(0 ratings)