3.0 KiB
Running Server Codebase
The server codebase is written in Java and is powered by Spring + WebFlux. This document explains how you can setup a development environment to make changes and test your changes.
Pre-requisites
- Java --- OpenJDK 11.
- Maven --- version 3+ (preferably 3.6).
- A MongoDB database --- A simple way to get this up is explained further down in this document.
- A Redis instance --- A simple way to get this up is explained further down in this document.
- An IDE --- We use IntelliJ IDEA as our primary IDE for backend development.
Steps for Setup
-
After cloning the repository, change your directory to
app/server -
Run the command
mvn clean compile
This generates a bunch of classes required by IntelliJ for compiling the rest of the source code. Without this step, your IDE may complain about missing classes and will be unable to compile the code.
- Create a copy of the
envs/dev.env.example
cp envs/dev.env.example .env
This command creates a .env file in the app/server folder. All run scripts pick up environment configuration from this file.
-
Modify the property values in the file
.envto point to your local running instance of MongoDB and Redis. -
In order to create the final JAR for the Appsmith server, run the command:
./build.sh
This command will create a dist folder which contains the final packaged jar along with multiple jars for the binaries for plugins as well.
- Start the Java server by running
./scripts/start-dev-server.sh
By default, the server will start on port 8080.
-
When the server starts, it automatically runs migrations on MongoDB and will populate it with some initial required data.
-
You can check the status of the server by hitting the endpoint: http://localhost:8080 on your browser. By default you should see a blank page.
Setting up a local MongoDB
The following command can bring up a MongoDB docker instance locally.
docker run -p 127.0.0.1:27017:27017 --name appsmith-mongodb -e MONGO_INITDB_DATABASE=appsmith -v /path/to/store/data:/data/db mongo
Please change the /path/to/store/data to a valid path on your system. This is where MongoDB will persist it's data across runs of this container.
Note that this command doesn't set any username or password on the database so we make it accessible only from localhost using the 127.0.0.1: part in the port mapping argument. Please refer to the documentation of this image to learn how to set a username and password.
When using this command, the value of APPSMITH_MONGODB_URI should be set to mongodb://localhost:27017/appsmith (which is what's provided in the example env file).
Setting up a local Redis
The following command can bring up a Redis docker instance locally.
docker run -p 127.0.0.1:6379:6379 --name appsmith-redis redis
When using this command, the value of APPSMITH_REDIS_URI should be set to redis://localhost:6379.