Skip to content

Latest commit

 

History

History
118 lines (85 loc) · 3.86 KB

README.md

File metadata and controls

118 lines (85 loc) · 3.86 KB
Raw

Contributors Forks Stargazers Issues


Table of Contents
  1. About The Project
  2. Usage
  3. Contributing
  4. Contact

About The Project

Peoplez is an open-source, self-hosted organisation management software that allows you to manage basic needs of your nonprofit organisation

Tech stack

Usage

You can spin up the project by following the steps below:

Without docker

A postgres database is required to run the project. You can set up a local postgres database or use a cloud service like Supabase

  1. Clone .env.example to .env and fill the database url fields

  2. Run the following scripts

    npm install
npm run db:push
npm run dev

  3. If you want to seed the database, run the following script before running the dev script

    npm run db:seed

Docker

A docker-compose file is provided for you to run the project and dependencies in a containerized environment.

  1. You can run the following command to start the project

    docker-compose up

This will spin up a local postgres database, maildev for easily troubleshooting email issues, and the project itself. Database seeds are automatically applied when the project starts.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

Contact

Schrödinger's Hat Team - @schroedinger_hat

Project Link: https://github.com/schroedinger-Hat/peoplez