1
0
Fork 0
mirror of https://gitlab.com/bramw/baserow.git synced 2025-04-08 06:40:07 +00:00

Resolve "Improve readme file"

This commit is contained in:
Bram Wiepjes 2020-07-14 09:05:22 +00:00
parent 7dc888e09e
commit b1471990f7
2 changed files with 73 additions and 14 deletions

View file

@ -1,26 +1,53 @@
# Baserow
Open source data collaboration platform.
Open source online database tool and Airtable alternative.
The complete toolchain for collaborating on any kind of data. One tool. Any device. Open
Source. Extendible. And were just getting started.
![Baserow screenshot](docs/assets/screenshot.png "Baserow screenshot")
## Introduction
Create own database without technical experience. Our user friendly no-code tool gives
you the powers of a developer without leaving your browser.
* Uses popular frameworks like [Django](https://www.djangoproject.com/) and
[Nuxt.js](https://nuxtjs.org/).
* Uses [PostgreSQL](https://www.postgresql.org/).
* Open source.
* MIT license.
* Self hosted.
* Headless and API first.
* Modular architecture.
* Supports plugins.
* Includes a plugin boilerplate.
* Unlimited rows.
* Runs in your browser.
* Alternative to Airtable.
## Try out a demo
If you just want to try out Baserow you can easily start a demo environment via
`docker-compose`. Just run the command following command and visit http://localhost:3000
in your browser
If you just want to try out Baserow, you can create an account on the SaaS version at
https://baserow.io. Just click on the create account or register button at the
homepage.
If you want to try out Baserow on your own computer, you can easily start a demo
environment via `docker-compose`. Just clone the repository, run the following commands
and visit http://localhost:3000 in your browser.
```
$ docker network create baserow_demo_default
$ docker-compose -f docker-compose.demo.yml up
```
## Core development
More detailed instructions and more information about the demo environment can be found
[here](./docs/guides/demo-environment.md) or at
https://baserow.io/docs/guides/demo-environment.
If you want to setup the development environment for core Baserow development you have
to execute the following commands to start the backend part. Note that the sandbox
container might have a different name like `backend_1`.
## Development environment
If you want to contribute to Baserow you need to setup the development environment.
Execute the following commands to start the backend API server.
> Note that the container might have a different name like `backend_1`.
```
$ docker network create baserow_default
@ -30,8 +57,11 @@ $ python src/baserow/manage.py migrate
$ python src/baserow/manage.py runserver 0.0.0.0:8000
```
In order to start the web-frontend environment you may execute the following commands.
Note that the sandbox container might have a different name like `web-frontend_1`.
Visit http://localhost:8000/api/groups/ in your browser and you should see a JSON
response containing "Authentication credentials were not provided.". This means that it
is working!
In order to start the web-frontend environment you may execute the following commands.
```
$ docker network create baserow_default
@ -40,5 +70,34 @@ $ yarn install
$ yarn dev
```
Now you'll have the Baserow development environment running. Visit http://localhost:3000
in your browser and you should see a working version in development mode.
The Baserow development environment is now running. Visit http://localhost:3000 in your
browser and you should see a working version in development mode.
More detailed instructions and more information about the development environment can
be found [here](./docs/development/development-environment.md) or at
https://baserow.io/docs/development/development-environment.
## Plugin development
Because of the modular architecture of Baserow it is possible to create plugins. Make
your own fields, views, applications, pages or endpoints. We also have a plugin
boilerplate to get you started right away. More information can be found in the
[plugin introduction](./docs/plugins/introduction.md) and in the
[plugin boilerplate docs](./docs/plugins/boilerplate.md).
## Official documentation
The official documentation can be found on the website at https://baserow.io/docs/index
or [here](./docs/index.md) inside the repository. The API docs can be found here at
https://api.baserow.io/api/redoc/ or if you are looking for the OpenAPI schema here
https://api.baserow.io/api/schema.json.
## Meta
Created by Bram Wiepjes (Baserow) - bram@baserow.io.
Distributes under the MIT license. See `LICENSE` for more information.
The official repository can be found at https://gitlab.com/bramw/baserow.
The changelog can be found [here](./changelog.md).

BIN
docs/assets/screenshot.png Normal file

Binary file not shown.

After

(image error) Size: 126 KiB