https://github.com/staticjscms/static-cms-proxy-server
Static CMS Proxy Server is an express server created to facilitate local development.
https://github.com/staticjscms/static-cms-proxy-server
Last synced: 7 months ago
JSON representation
Static CMS Proxy Server is an express server created to facilitate local development.
- Host: GitHub
- URL: https://github.com/staticjscms/static-cms-proxy-server
- Owner: StaticJsCMS
- Created: 2022-10-10T12:24:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-23T10:17:19.000Z (about 1 year ago)
- Last Synced: 2024-05-01T11:23:53.725Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 414 KB
- Stars: 3
- Watchers: 2
- Forks: 5
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Static CMS Proxy Server
Static CMS Proxy Server is an express server created to facilitate local development.
## How It Works
1. Navigate to a local Git repository configured with the CMS.
2. Run `npx @staticcms/proxy-server` from the root directory of the above repository.
3. Update your `config.yml` to connect to the server:
```yaml
backend:
name: proxy
proxy_url: http://localhost:8081/api/v1
branch: master # optional, defaults to master
```
4. Start you local development server.
## Custom Configuration
1. Create a `.env` file in the root directory of your local Git repository.
2. Update the file as follows:
```bash
# optional, defaults to current directory
GIT_REPO_DIRECTORY=FULL_PATH_TO_LOCAL_GIT_REPO
# optional, defaults to 8081
PORT=CUSTOM_PORT
```