# gitpress

**Repository Path**: lopinx/gitpress

## Basic Information

- **Project Name**: gitpress
- **Description**: Run your WP site on github pages based on simply-static.
- **Primary Language**: PHP
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-08
- **Last Updated**: 2024-10-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Gitpress
Run wordpress directly on github pages

## Gitpress won the innovation award for may 2021
Read more about this [https://naveen17797.github.io/gitpress-won-the-php-innovation-award/](here)

## Want to see live demo ? 
Go to my github pages site at [https://naveen17797.github.io/](https://naveen17797.github.io/)

## What does this repo do ?
This helps to host your wordpress site in github pages

## How does it do it ?
1. It runs wordpress on your local docker container
2. It generates static files with the help of the plugin [simply static](https://github.com/patrickposner/simply-static) written by [Patrick Posner](https://patrickposner.dev/)
3. It pushes all the static files to your github pages

## How can i install ?
1. Clone the repo.
2. Run `docker-compose up` 
3. Open http://localhost, set up your wordpress site
4. Add your github username and password ( or token )
5. Click on sync site on the top admin bar, thats it.
![2021-05-24_05-58](https://user-images.githubusercontent.com/18109258/119281888-1a096f00-bc55-11eb-9ea8-495ee09682e7.png)
6. Now do that every time when you want to sync your local site to github pages.

## I want to backup my database

1. Stop the db container
2. Run `docker-compose stop db`
3. Run `docker-compose run --rm db-backup`
4. This will backup your database to backup folder.

## I want to restore my backup
1. Run `docker-compose run --rm db-restore`
2. This will restore your backup.


## Can i use it in my production environment ?
No