Nine Yards

Nine Yards (As in "going the whole nine yards") is a self hosted, free, and open source team and project management tool. Like Trello or Asana, just you don't spend your life savings on the utilities your team wants, needs and everything in between.

Why Nine Yards

TODO

Getting started with Nine Yards

Nine Yards can be run in multiple configurations so you'll need to make some choices before getting started.

If you don't already have an idea of where you can host your own Nine Yards instance look here.

Picking a database

Nine Yards fully supports both SQLite and Postgres functionality wise you'll see no difference. By default SQLite is used for ease of setup but if you are expecting many concurrent users often, or or any other reason, you may want to use postgres instead.

Hosting the site

Nine Yards' front end can either be served statically from the backend or can be ran seperately allowing server side rendering to be utilised. If you dont have multiple servers it's likely best to serve the site statically; although, you can run both concurrently and route incoming traffic using software like Nginx as a reverse proxy.

Using Docker (Reccomended)

TODO

Building From Source

To build Nine Yards from source you need some tools first. For the backend install Rust through Rustup and for the front end Node.js aswell as pnpm which can be installed using npm, which is bundled with Node.js.

Getting the source

# Clone this repository
git clone https://github.com/Rabbitminers/Nine-Yards
cd Nine-Yards

Building the project

# This may take some time as all dependencies need to be downloaded and compiled

# Build everything
make build

# or

# Build only the frontend site
make build-frontend

# Build only the backend
make build-backend

Running Nine Yards

# Make sure to configure your instance first
make run

What if I don't have a server?

There are many great options for hosting Nine Yards both cloud and localy. If you are looking for something free, Oracle Web Infrastructure's free trial is permanent and more than powerful enough' a full specification list can be found here.

As well as this, they offer splitting your resources between multiple instances, which can be useful if you are intending on running Nine Yards split, allowing you to take advantage of server side rendering, to improve site performance and allowing for the front end and backend to be scaled seperately with minimal difficulty if needed.

Tech Stack

For contributors or anyone interrested in how Nine Yards works:

• Frontend - SvelteKit, Svelte, Tailwind
• Backend - Rust, Axum, sqlx
• Database - Sqlite / Postgres

Want Help?

Have an issue, a feature requst or just want to ask a question? You can contact us over email, here on github or on discord in the server below

You can find the API Documentation through the OpenAPI spec here. Alternatively if enabled you can view the spec through Swagger UI on the /swagger-ui endpoint of your instance.

Licenses

Nine Yards is free and open source, and is licensed under GNU GPLv3 a summary of what this means can be found here.