Mathesar is a project to make databases easier to use for non-technical users. Our aim is help users of all skill levels store, manipulate, visualize, and collaborate with others on data.
We are currently in early development and hope to release an alpha version by late 2021. Please see the Mathesar wiki for more information about the project.
Table of Contents
We actively encourage contribution! Join our community and read through our contributing guidelines.
First, ensure that you have Docker installed.
Clone the repository and then copy the .env.example file to .env like so:
cp .env.example .env
From the repository's root directory, run:
docker-compose up
If it's your first time running the application, you'll also need to run database migrations and install Mathesar types and functions:
docker exec mathesar_service_1 python manage.py migrate
docker exec -it mathesar_service_1 python install.py
You should now have a web server and database server running. Opening http://localhost:8000 in your browser will open the application. For sample table data, you can create a new table in the UI using the patents.csv file found in /mathesar/tests/data.
It is recommended that you keep the Docker containers running while you make changes to the code. Any change to the code made locally will sync to the container and the version deployed at http://localhost:8000 will always be the latest local version of the code.
Windows users who want to run the Mathesar Docker development environment in WSL are advised to clone the repository in a Linux filesystem. When the project resides in a Windows filesystem, WSL does not work well with hot module replacement (HMR), which is required for frontend development. Please refer to our Common Issues wiki page, and the frontend development README file for more details.
If you want to use Mathesar with a preexisting Postgres DB, modify the DATABASES.mathesar_tables entry of the config/settings.py file with appropriate connection details before installing the Mathesar types and functions by running install.py as described in the previous step.
Please don't do this unless you have full confidence in what you're doing since Mathesar is not stable yet and may make unexpected changes to the database that you connect to it.
For more detailed information on Mathesar's frontend development, please refer the readme file within mathesar_ui directory.
To lint the project, run the lint.sh script from the root of the repository. The script requires that the Python virtual environment with flake8 be activated and that Node modules be installed in mathesar_ui/. Alternatively, ESLint and Flake8 should be installed globally on the system.
./lint.sh
By default, the script lints both Python and Node.js (if changes are staged), but this can be overridden with the -p and -n flags respectively.
./lint.sh -p false
You should symlink the script as your pre-commit hook to ensure that your code is linted along-side development.
ln -s ../../lint.sh .git/hooks/pre-commit
If you'd like to run tests before pushing, here's how you do it:
Backend tests:
docker exec mathesar_service_1 pytest
Frontend tests:
docker exec mathesar_service_1 bash -c "cd mathesar_ui && npm test"
If you need to do some work on the container that's running the code, here's how you access it:
docker exec -it mathesar_service_1 bash
Please refer to our Common Issues wiki page for instruction on troubleshooting common issues while setting up and running Mathesar.
Mathesar is open source under the GPLv3 license - see LICENSE. It also contains derivatives of third-party open source modules licensed under the MIT license. See the list and respective licenses in THIRDPARTY.