PromucFlow_constructor/app/server/README.md
Nayan 212678a540
[Docs] Imrove readme file in server, improve client getting started g… (#4327)
* [Docs] Imrove readme file in server, improve client getting started guide

* -updated the ClientSetup readme as per PR comment
2021-05-07 16:55:48 +06:00

35 lines
906 B
Markdown

# Appsmith Server
This is the server-side repository for the Appsmith framework.
For details on setting up your development machine, please refer to the [Setup Guide](https://github.com/appsmithorg/appsmith/blob/release/contributions/ServerSetup.md)
### How to build
```bash
$ ./build.sh <arguments>
```
For example:
```$bash
$ ./build.sh -DskipTests
```
This script will perform the following steps:
1. Compile the code
2. Generate the jars for server & plugins
3. Copy them into the `dist` directory
### How to run
```
$ cd ./dist
$ java -jar -Dspring.profiles.active=$env server-1.0-SNAPSHOT.jar
```
### How to test
In order to test the code, you can run the following command:
```
mvn -B clean package
```
Please make sure that you have a local Redis instance running for the test cases. During tests, the MongoDB is run in-memory. So you don't require to be running a local MongoDB instance.