An open API service indexing awesome lists of open source software.

https://github.com/schroedinger-hat/peoplez

Peoplez is an open-source, self-hosted organisation management software that allows you to manage basic needs of your nonprofit organisation
https://github.com/schroedinger-hat/peoplez

Last synced: 4 months ago
JSON representation

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

Awesome Lists containing this project

README

          

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]




Peoplez


Logo




Explore the docs »




Report Bug
·
Request Feature


Table of Contents



  1. About The Project


  2. Usage

  3. Contributing

  4. Contact

  5. Maintainers

## 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

- [Next.js](https://nextjs.org)
- [Prisma](https://prisma.io)
- [Tailwind CSS](https://tailwindcss.com)
- [shadcn-ui](https://ui.shadcn.com/)
- [NextAuth.js](https://next-auth.js.org)
- [React Email](https://react.email/)

## 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](https://supabase.io/)

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](mailto:social@schroedinger-hat.org)

Project Link: [https://github.com/schroedinger-Hat/peoplez](https://github.com/schroedinger-Hat/peoplez)

[contributors-shield]: https://img.shields.io/github/contributors/schroedinger-Hat/peoplez.svg?style=for-the-badge
[contributors-url]: https://github.com/schroedinger-Hat/peoplez/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/schroedinger-Hat/peoplez.svg?style=for-the-badge
[forks-url]: https://github.com/schroedinger-Hat/peoplez/network/members
[stars-shield]: https://img.shields.io/github/stars/schroedinger-Hat/peoplez?style=for-the-badge
[stars-url]: https://github.com/schroedinger-Hat/peoplez/stargazers
[issues-shield]: https://img.shields.io/github/issues/schroedinger-Hat/peoplez.svg?style=for-the-badge
[issues-url]: https://github.com/schroedinger-Hat/peoplez/issues

## Maintainers






Lorenzo Pieri



Lorenzo Pieri




💻 Maintainer



Miki Lombardi



Miki Lombardi




💻 Maintainer



Patrick Raedler



Patrick Raedler




💻 Maintainer



Mattia Lobertini



Mattia Lobertini




💻 Maintainer