bokjo/praxis-api

Praxis is an open source social network with features for collaborative decision making. Proposals are the main focus and can be used to plan events, update roles and permissions, or even make changes to how the app works.

Praxis

Praxis is an open source social network with features for collaborative decision making. Proposals are the main focus and come with a wide variety of voting models, with consensus as the default. Create a group and set it to no-admin, allowing group members to create proposals and democratically decide on name, settings, roles, or planning of real world events.

While model of consensus is the default, group members will also be able to use regular majority vote, and have the ability to create and assign new roles with various permissions. All of this can be tailored in group settings to meet the specific needs of your community, either by a groups admin, or by proposals as a group evolves over time.

The tech stack includes:

• NestJS
• GraphQL
• TypeORM

Praxis UI: https://github.com/praxis-project/praxis-ui

Praxis is free and open source software, as specified by the GNU General Public License.

Work in Progress

You are entering a construction yard. Things are going to change and break regularly as the project is still getting off the ground. Your feedback is highly welcome.

Core features currently in development:

• Change group roles, permissions, and settings all via proposals
• Plan real world events via proposals and voting
• Federation with ActivityPub

Installation

Ensure that you're using Node v16.13.2 before proceeding.

# Install Yarn globally
$ npm install -g yarn

# Install project dependencies
$ cd praxis-api && yarn

# Add .env file and edit as needed
$ cp .env.example .env

Instructions for setting up the UI are located here: https://github.com/praxis-app/praxis-ui#installation

Running the app

# Development
$ yarn start

# Watch mode
$ yarn start:dev

# Production mode
$ yarn start:prod

Open http://localhost:3100/api with your browser to view and interact with the API.

Make and Docker

Ensure that you have Make and Docker installed to use the following commands.

# Build the app
$ make build-dev

# Start the app
$ make start-dev

Testing

# Unit tests
$ yarn test

# E2E tests
$ yarn test:e2e

# Test coverage
$ yarn test:cov

Prettier and ESLint

# Enable pre-commit hook with Husky
$ npx husky install && npx husky add .husky/pre-commit "yarn lint-staged"

Contributions

Praxis is open to contributions. Please read CONTRIBUTING.md for more details.