https://github.com/flownative/localbeach
The Local Beach client written in Go
https://github.com/flownative/localbeach
developer-tools development-environment flownative-beach golang hacktoberfest localbeach neos-cms neos-flow
Last synced: about 2 months ago
JSON representation
The Local Beach client written in Go
- Host: GitHub
- URL: https://github.com/flownative/localbeach
- Owner: flownative
- License: apache-2.0
- Created: 2020-01-17T09:54:38.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-04-02T15:28:26.000Z (2 months ago)
- Last Synced: 2025-04-02T16:22:47.979Z (2 months ago)
- Topics: developer-tools, development-environment, flownative-beach, golang, hacktoberfest, localbeach, neos-cms, neos-flow
- Language: Go
- Homepage:
- Size: 535 KB
- Stars: 7
- Watchers: 4
- Forks: 4
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Local Beach
Local Beach is a development environment for [Neos CMS](https://www.neos.io) and [Flow Framework](https://flow.neos.io).
Under the hood, it's using Docker, and the official Beach Docker images (Nginx, PHP and Redis). You don't need a Beach
account nor be a [Flownative](https://www.flownative.com) customer in order to use Local Beach because Local Beach is
free (as in free beer, or free coffee).
This README currently only contains basic information about Local Beach. You may find more information on the
[Local Beach website](https://www.flownative.com/localbeach).
These are the [setup instructions](https://www.flownative.com/en/documentation/guides/localbeach/local-beach-setup-docker-based-neos-development-howto.html) for Local Beach.
Currently, automatic installation via Homebrew is supported.
tldr;
```
brew tap flownative/flownative
brew install localbeach
beach version
```
## Internals
Some random notes about the internals of Local Beach:
- `beach setup` is automatically invoked by Homebrew when Local Beach is installed
- the base path for Local Beach is `~/Library/Application Support/Flownative/Local Beach/` on macOS and
`~/.Flownative/Local Beach/` on other systems
## Build
To build the binary, run `make`. It does this:
```bash
rm -f assets/compiled.go
go generate -v
go install -v
go build -v -ldflags "-X github.com/flownative/localbeach/pkg/version.Version=dev" -o beach
```
For a slightly quicker build, use `make compile`.
## Credits and Support
This library was developed by Robert Lemke with major contributions by Karsten Dambekalns and Christian Müller. Feel
free to suggest new features, report bugs or provide bug fixes in our GitHub project.
Copyright 2019-2024 Robert Lemke, Karsten Dambekalns, Christian Müller, licensed under the Apache License, version 2.0.