💽 You should have nvm installed; then run
nvm use. If you can't use nvm, you should use Node 18 for development for consistency sake.
This is a monorepo. Run yarn boot to install all dependencies.
The base package contains the core of the project. In there, you'll find code related to dealing with collections, plugins, handling requests (aka contexts), etc.
You'll need to interface with the base using a server. So there are two implementations: @mangobase/express and @mangobase/bun. You'll also need to provide a database but we have an implementation: @mangobase/mongodb.
It's recommended to create a separate branch for your contributions. First, fork this project then make your changes. Submit a PR when you think its ready to be merged.
See: https://docs.github.com/en/get-started/quickstart/contributing-to-projects
When contributing to the base, you many need to test your implementation using unit tests/specs.
To actually validate your code, run yarn build:base && yarn copy-admin. You can then use one of the example projects to test your code. Do yarn dev:express-mongo or bun dev:bun-mongo
You should have bun installed to try the bun example.
You can then use an HTTP client to test endpoints.
Another way to validate your addition is to use the admin/dev dashboard.
The [dev] admin panel is where the low-code experience happens. It's developed with Vite/Preact.
Run it with yarn dev:admin. You need to have a server running. Run one with yarn dev:express-mongo
Whenever you make changes to base, you'll need to restart express-mongo for backend changes to reflect.