Adds YT Setup Videos to Docs (#5744)

This commit is contained in:
Confidence Okoghenun 2021-07-09 11:24:34 +01:00 committed by GitHub
parent 193f20ad7a
commit f5f73b47c6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 50 additions and 46 deletions

View File

@ -1,9 +1,4 @@
## Dev Dependencies
- `yarn`
- `nvm`
## Dev Setup
# Appsmith Client
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
<br><br>
For details on setting up your development machine, please refer to the [Setup Guide](../../contributions/ClientSetup.md)

View File

@ -1,39 +1,4 @@
# 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](../../contributions/ServerSetup.md). Alternatively, you can run the server using docker(see the instructions below).
## Run locally with Docker
You can run the server codebase in a docker container. This is the easiest way to get the server up and running if all you care about is contributing to the client codebase.
### What's in the box
* Appsmith server
* MongoDB
* Redis
### Pre-requisites
* [Docker](https://docs.docker.com/get-docker/)
### Steps for setup
1. Clone the Appsmith repository and `cd` into it
```sh
git clone https://github.com/appsmithorg/appsmith.git
cd appsmith
```
2. Change your directory to `app/server`
```sh
cd app/server
```
3. Create a copy of the `envs/docker.env.example`
```sh
cp envs/docker.env.example envs/docker.env
```
4. Start up the containers
```sh
docker-compose up -d
```
5. Have fun!
<br><br>
For details on setting up your development machine, please refer to the [Setup Guide](../../contributions/ServerSetup.md)

View File

@ -2,6 +2,10 @@
Appsmith's client (UI/frontend) uses the ReactJS library and Typescript. The application also uses libraries like react-redux and redux-saga for workflows. We use VS Code Editor as our primary editor
[![How to Setup Appsmith for Client Side Development](../static/images/client-yt-video-thumbnail.jpg)](https://www.youtube.com/watch?v=FwJlVWVx0X0)
### Pre-requisites:
On your development machine, please ensure that:

View File

@ -1,8 +1,48 @@
## Running Server Codebase
# Running Server Codebase
This document explains how you can setup a development environment for Appsmith server. As the server codebase is written in Java and is powered by Spring + WebFlux we need Java and Maven installed to build the code. In addition we also need one instance of MongoDB and Redis each to run Appsmith server. Lastly, we will set up IntelliJ IDEA to let you edit the code. Let's get those prerequisites installed on your machine.
>If you are not setting up a development environment you can get the Appsmith server up and running quickly with `Docker`. Please refer to the [Setup Guide](../app/server/README.md#run-locally-with-docker) on how to do that.
[![How to Setup Appsmith for Server Side Development](../static/images/server-yt-video-thumbnail.jpg)](https://www.youtube.com/watch?v=W2qbuUYGrQs)
# Setup with Docker
You can run the server codebase in a docker container. This is the easiest way to get the server up and running if you are more interested in contributing to the client codebase.
## What's in the box
* Appsmith server
* MongoDB database
* Redis instance
## Pre-requisites
* [Docker](https://docs.docker.com/get-docker/)
## Steps for setup
1. Clone the Appsmith repository and `cd` into it
```
git clone https://github.com/appsmithorg/appsmith.git
cd appsmith
```
2. Change your directory to `app/server`
```
cd app/server
```
3. Create a copy of the `envs/docker.env.example`
```
cp envs/docker.env.example envs/docker.env
```
4. Start up the containers
```
docker-compose up -d
```
5. Have fun!
# Local Setup
## Pre-requisites

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB