nexus-api

Self-hosteable social network

Nexus formal definition: a relationship or connection between people or things. Source.

Deployment

This application is published to a Heroku Dyno instance using the emk/heroku-buildpack-rust on every push to main throught this action.

Development

Requirements

• Rust and Cargo (Rustup)
• SQLx CLI

Getting Started

1. Clone this repository

git clone https://github.com/whizzbit/nexus-api.git

2. Create a copy of .env.sample in a new file with the name: .env

cp ./.env.sample ./.env

3. Execute Docker containers:

docker compose up

4. Run database migrations running sqlx migrate run. You must complete SQLx Setup First.

5. Open a new terminal session and run the server

cargo run

Setup SQLx for Database Migrations

Install SQLx CLI using cargo install for PostgreSQL only

cargo install sqlx-cli --no-default-features --features native-tls,postgres

GraphQL

The API exposed is build using async-graphql, which is a GraphQL implementation build for Rust.

Visit the playground on http://host:port/graphql, when running the project locally.

This GraphQL implementation uses the Cursors Connections Pattern.

The DateTime scalar

Our GraphQL gateway implements the DateTime scalar to specify date values. You can read more on this scalar here: DateTime.

Contributing

Every kind of contribution to this project is welcome, please, don't hesitate to open a Pull Request or Issue. I will be happy to help!