Table of Contents
Peoplez is an open-source, self-hosted organisation management software that allows you to manage basic needs of your nonprofit organisation
You can spin up the project by following the steps below:
A postgres database is required to run the project. You can set up a local postgres database or use a cloud service like Supabase
-
Clone .env.example to .env and fill the database url fields
-
Run the following scripts
npm install npm run db:push npm run dev -
If you want to seed the database, run the following script before running the dev script
npm run db:seed
A docker-compose file is provided for you to run the project and dependencies in a containerized environment.
-
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.
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!
Schrödinger's Hat Team - @schroedinger_hat
Project Link: https://github.com/schroedinger-Hat/peoplez
