nexus

Self-hosteable social network

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

Development

Requirements

• NodeJS

Getting Started

1. Clone this repository

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

2. In a separate terminal session, install project dependencies.

npm install

3. Run the server

npm run dev

The project must be available on http://localhost:3000.

GraphQL Code Generation

This project make use of URQL and GraphQL Codegen to interact with the server GraphQL API. You must generate GraphQL server bindings and then import them to perform any queries or mutations.

Make sure a .env file is available with the same contents as .env.example.

Make sure VITE_API_URL points to an instance of nexus-server

Execute npm run gql:generate to generate the src/lib/graphql/schema.ts file. You must import any queries and mutations from this file and use them in the service implementation.

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!