praxis

(โ˜… 96)

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.

  • .env.example
  • .eslintignore
  • .eslintrc
  • .gitignore
  • .prettierrc
  • CODE_OF_CONDUCT.md
  • codegen.js
  • CONTRIBUTING.md
  • docker-compose.yml
  • Dockerfile
  • graphql.config.js
  • i18nrc.js
  • LICENSE
  • nest-cli.json
  • package-lock.json
  • package.json
  • README.md
  • schema.graphql
  • SECURITY.md
  • tsconfig.build.json
  • tsconfig.json

# Installation Guide

1. Get the code
git clone https://github.com/praxis-app/praxis

Downloads the entire project code from GitHub to your computer.

cd praxis

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • 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

Builds and starts all defined containers (server, database, etc.) at once, 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.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
$ npm install

Downloads and installs the libraries listed in package.json.

$ npm run start:dev

Starts the development/run server.

$ npm run start:client

Starts the development/run server.

$ npm run start:prod

Starts the development/run server.

$ npm run gen

Type this command into your terminal and run it.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation