Paul — The Database Manager

An easier way to manage your NGO's databases

Find out more about the project

Contributing | Built with | Feedback | License | About Code for Romania

Contributing

This project is built by amazing volunteers, and you can be one of them. Here's a list of ways in which you can contribute to this project. If you want to make any change to this repository, please make a fork first.

Help us out by testing this project in the staging environment. If you see something that doesn't quite work the way you expect it to, open an Issue. Make sure to describe what you expect to happen and what is actually happening in detail.

If you would like to suggest new functionality, open an Issue and mark it as a [Feature request]. Please be specific about why you think this functionality will be of use. If you can, please include some visual description of what you would like the UI to look like if you’re suggesting new UI elements.

Built With

Frontend

• JavaScript
• React.js
• Vite
• Tailwind CSS
• Package manager: npm

Backend

• Python 3
• Django
• Package manager: uv

Database technology & provider

• PostgreSQL

Platforms

• AWS through Terraform
• Docker for local development and deployment

Development

Deployment without Docker

Prerequisites

• Python 3.13 with UV
  • Install UV with: curl -LsSf https://astral.sh/uv/install.sh | sh
• NVM to install and manage Node.js LTS versions
• a PostgreSQL 17 database (can be run with Docker)

1. Go to the root of the project
2. Run cp .env.example .env.local to create the environment file
3. Configure your database to run with the configuration in the .env.local file or run the database using docker with docker compose up -d db_psql_dev or make rund-db
4. Set up the Node.js environment
   1. Go to the frontend directory
   2. Run nvm use || nvm install to install the Node.js version specified in the .nvmrc file
   3. Run npm i to install the Node.js dependencies
5. Set up the Python environment
   1. Go to the backend directory
   2. Install the Python dependencies by running uv sync

Running the project

1. Run the Django project in one terminal
   1. Go to the backend directory
   2. Run source .venv/bin/activate to activate the Python virtual environment
   3. Run django-admin runserver localhost:8000 to start the Django development server
2. Run the frontend in another terminal
   1. Go to the frontend directory
   2. Run nvm use to use the Node.js version specified in the .nvmrc file
   3. Run npm run dev to start the frontend development server
3. Open http://localhost:8000 in your browser

ℹ️ Configure whatever port works best for you. For Django, change the :8000 to whatever works best for you. For the frontend, set the DJANGO_VITE_DEV_SERVER_PORT variable in the .env.local file

‼️ In case of problems with the instructions, please open an issue. If you managed to find a solution, please open a PR with the changes.

Deployment With Docker

1. Go to the root of the project
2. Run cp .env.example .env to create the environment file
3. Run make run to start the containers with an PostgreSQL database
4. Open http://localhost:8080 in your browser

Feedback

• Request a new feature on GitHub.
• Vote for popular feature requests.
• File a bug in GitHub Issues.
• Email us with other feedback [email protected]

License

This project is licensed under the MPL 2.0 License — see the LICENSE file for details

About Code for Romania

Started in 2016, Code for Romania is a civic tech NGO, official member of the Code for All network. We have a community of around 2.000 volunteers (developers, ux/ui, communications, data scientists, graphic designers, devops, it security and more) who work pro bono for developing digital solutions to solve social problems. #techforsocialgood. If you want to learn more details about our projects visit our site or if you want to talk to one of our staff members, please e-mail us at [email protected].

Last, but not least, we rely on donations to ensure the infrastructure, logistics and management of our community that is widely spread across 11 timezones, coding for social change to make Romania and the world a better place. If you want to support us, you can do it here.