From a2cbab0bc396a252b4b3beeb806010c8dfe32d1f Mon Sep 17 00:00:00 2001 From: Ahmed Bouhuolia Date: Sun, 5 Nov 2023 03:28:04 +0200 Subject: [PATCH] chore: update README.md to add Gitpod --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 9db2572d6..5476c3201 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,31 @@ Bigcapital is a smart and open-source accounting and inventory software, Bigcapi

+# Getting Started + +We've got serveral options on dev and prod depending on your need to get started quickly with Bigcapital. + +## Self-hosted + +Bigcapital is available open-source under AGPL license. You can host it on your own servers using Docker. + +### Docker + +To get started with self-hosted with Docker and Docker Compose, take a look at the [Docker guide](https://docs.bigcapital.ly/deployment/docker). + +## Development + +### Local Setup + +To get started locally, we have a [guide to help you](https://github.com/bigcapitalhq/bigcapital/blob/develop/CONTRIBUTING.md). + +### Gitpod + +- Click the Gitpod button below to open this project in development mode. +- This will open and configure the workspace in your browser with all the necessary dependencies. + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/new/#https://github.com/bigcapitalhq/bigcapital) + # Resources - [Documentation](https://docs.bigcapital.ly/) - Learn how to use.