Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved README Documentation #92

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 57 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,31 @@ tool gives you the powers of a developer without leaving your browser.
```bash
docker run -v baserow_data:/baserow/data -p 80:80 -p 443:443 baserow/baserow:1.27.2
```

![Baserow screenshot](docs/assets/screenshot.png "Baserow screenshot")

## Features Overview
* No-Code Database Management: Create, manage, and share databases without writing any code.
* Collaborative: Work with your team in real-time with multi-user support.
* Self-Hosting: Full control over your data by hosting Baserow on your own server.
* Flexible API: Easily integrate Baserow with other applications using our API.
* Custom Fields and View: Customize your data tables with various field types (text, number, boolean, etc.) and views (grid, form, calendar).
* Modular Architecture: Extend functionality with plugins and custom features.

## Table of Contents
- [Introduction](#baserow-is-an-open-source-no-code-database-tool-and-airtable-alternative)
- [Features Overview](#features-overview)
- [Quick Start](#quick-start)
- [Installation](#installation)
- [Development Environment](#development-environment)
- [Plugin Development](#plugin-development)
- [Troubleshooting](#troubleshooting)
- [Versioning and Upgrades](#versioning-and-upgrades)
- [Official Documentation](#official-documentation)
- [Meta](#meta)




## Get Involved

**We're hiring remotely**! More information at https://baserow.io/jobs.
Expand All @@ -41,6 +63,18 @@ Join our forum on https://community.baserow.io/. See
* [**Railway**: Install Baserow via Railway.](docs/installation/install-on-railway.md)
* [**Elestio**: Fully managed by Elestio.](https://elest.io/open-source/baserow)


## Quick Start
If you're new to Baserow, follow these quick steps to get started in minutes:
1. Install Docker on your machine from [here](https://www.docker.com/get-started).
2. Pull and run the Baserow Docker image:
```bash
docker pull baserow/baserow:latest
3. Run the following command to start Baserow:
docker run -v baserow_data:/baserow/data -p 80:80 -p 443:443 baserow/baserow:latest
4. Open http://localhost in your browser to access Baserow.


## Official documentation

The official documentation can be found on the website at https://baserow.io/docs/index
Expand Down Expand Up @@ -83,6 +117,28 @@ 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).

## Troubleshooting
## Issue: Docker container fails to start
* Solution: Make sure Docker is installed and running properly. You can check Docker’s status with the following command:
```bash
docker ps
## If Docker isn't running, restart the service and try running the Baserow container again.


## Versioning and Upgrades
* To check the current version of Baserow running on your machine, use the following command:
```bash
docker exec -it baserow baserow version

## Support and Contact Information
If you encounter any issues while using Baserow, feel free to reach out to the support team or use the following resources:

* Community Forum: Join the discussion at [Baserow Community](https://community.baserow.io/).
* Documentation: Check our full [documentation](https://baserow.io/docs) for detailed guides and troubleshooting tips.
* Email Support: You can contact our support team directly at support@baserow.io.
* GitHub Issues: Report bugs or request features by creating an issue on our [GitHub repository](https://github.com/bram2w/baserow/issues).


## Meta

Created by Baserow B.V. - bram@baserow.io.
Expand Down