archive/bramw_baserow
1
0
Fork 0
mirror of https://gitlab.com/bramw/baserow.git synced 2025-04-04 13:15:24 +00:00
Code Issues Projects Releases Wiki Activity

updated readme for the sandbox environment

Browse source
This commit is contained in:
Bram Wiepjes 2019-06-21 11:49:56 +02:00
parent b2f8e33b5f
commit 4fe6b6a413
1 changed files with 53 additions and 17 deletions

70
README.md
View file

@ -7,28 +7,64 @@ $ docker network create baserow_default
$ docker-compose up -d
```
In order to start developing for the web frontend you need to execute the following commands.
If you just want to try out the application I recommend using the sandbox environment to start. First you need to open bash in the just created container and then you should navigate to the sandbox directory, start the django development server, start the nuxt development server and visit http://localhost:3000 in your browser. An example of the commands is described below.
```
# terminal window 1
$ docker exec -it baserow bash
$ cd /baserow/sandbox
$ yarn install
$ yarn run dev
# terminal window 2
$ docker exec -it baserow bash
$ cd /baserow/sandbox
$ python manage.py runserver 0.0.0.0:8000
```
Both servers should be running and if you visit http://localhost:3000 you should see a working version of Baserow.
## Development
In order to start developing for the backend you need to execute the following commands.
```
docker exec -it baserow bash
cd /baserow/backend/src/baserow
python manage.py runserver 0.0.0.0:8000
```
In order to start developing for the web frontend you need to execute the following commands. Note that the backend server must also be running.
```
# install web frontend dependencies
$ docker exec -it baserow bash
$ cd /baserow/web-frontend
$ yarn install
$ yarn run dev
# build for production and launch server
$ yarn run build
$ yarn start
# generate static project
$ yarn run generate
# lint
$ yarn run eslint
$ yarn run stylelint
# test
$ yarn run test
```
When the development server starts you can visit http://localhost:3000.
When the development servers are on you can visit http://localhost:3000.
## Testing and linting
There are a few commands you can use inside the container to test and lint parts of the code.
```
$ docker exec -it baserow bash
$ cd /baserow
# run pytest for the backend
$ make lint-backend
# run flake8 for the backend
$ make test-backend
# run jest for the web frontend
$ make test-web-frontend
# run eslint for the web frontend
$ make eslint-web-frontend
# run stylelint for the web frontend
$ make stylelint-web-frontend
```