mirror of
https://github.com/frappe/frappe_docker.git
synced 2026-06-18 14:15:09 +00:00
readme updated
This commit is contained in:
parent
9eaa4f87c0
commit
932b60a293
1 changed files with 24 additions and 1 deletions
25
README.md
25
README.md
|
|
@ -20,7 +20,30 @@ The stack includes:
|
|||
4. **Frappe Framework** - The underlying framework
|
||||
5. **Supporting Services** - MariaDB, Redis, PostgreSQL, Nginx
|
||||
|
||||
## 🚀 Quick Start
|
||||
## 🚀 I. Quick Start (Local)
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- GitHub account with access to all repositories
|
||||
- Git and Docker on you machine
|
||||
|
||||
### Basic Setup
|
||||
|
||||
1. Clone this repository
|
||||
2. Create `.env` file in the root folder (check `.env.example` for inspiration)
|
||||
3. Run `docker compose up -d`
|
||||
4. Create a site by running `bash ./scripts/create-site.sh <your_site_name>`
|
||||
5. Set your site name in your machine's hosts file
|
||||
- add the following line to your machine's hosts file
|
||||
```
|
||||
127.0.0.1 <your_site_name>
|
||||
```
|
||||
- hosts file location on mac / linus: `/etc/hosts/`
|
||||
- hosts file location on windows: `C:\Windows\System32\drivers\etc\hosts`
|
||||
6. Type <your_site_name> in your browser
|
||||
|
||||
|
||||
## 🚀 II. Quick Start (CI/CD)
|
||||
|
||||
For detailed deployment instructions, see [DEPLOYMENT.md](DEPLOYMENT.md).
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue