Skip to content

Commit

Permalink
Adds YT Setup Videos to Docs (#5744)
Browse files Browse the repository at this point in the history
  • Loading branch information
megaconfidence authored Jul 9, 2021
1 parent 193f20a commit f5f73b4
Show file tree
Hide file tree
Showing 6 changed files with 50 additions and 46 deletions.
9 changes: 2 additions & 7 deletions app/client/README.md
Original file line number Diff line number Diff line change
@@ -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)
39 changes: 2 additions & 37 deletions app/server/README.md
Original file line number Diff line number Diff line change
@@ -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)
4 changes: 4 additions & 0 deletions contributions/ClientSetup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
44 changes: 42 additions & 2 deletions contributions/ServerSetup.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Binary file added static/images/client-yt-video-thumbnail.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/server-yt-video-thumbnail.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f5f73b4

Please sign in to comment.