https://github.com/karmek-k/git-guestbook
📕 Modern guestbooks for GitHub (not finished yet)
https://github.com/karmek-k/git-guestbook
Last synced: 3 months ago
JSON representation
📕 Modern guestbooks for GitHub (not finished yet)
- Host: GitHub
- URL: https://github.com/karmek-k/git-guestbook
- Owner: karmek-k
- License: agpl-3.0
- Created: 2021-05-18T15:41:21.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-06-09T10:30:00.000Z (almost 4 years ago)
- Last Synced: 2025-01-11T01:51:01.908Z (5 months ago)
- Language: PHP
- Homepage:
- Size: 508 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitGuestbook [](https://github.com/karmek-k/git-guestbook/actions/workflows/test.yml)
Modern guestbooks for GitHub.
Work in progress!
## Installation
GitGuestbook requires PHP 8 or greater.
You'll also need Composer, Node.js with Yarn and a database (I used PostgreSQL).
1. Install dependencies
`composer install`
2. Either create a `.env.local` file from `.env` template:
`cp .env .env.local`
or provide the environment variables manually.
**PLEASE** make sure that the `APP_ENV` variable
is set to either `dev` or `prod`!
Deploying on the `dev` environment poses a major security risk!
3. Create the database and apply migrations:
```
php bin/console doctrine:database:create
php bin/console doctrine:migrations:migrate
```
4. Install Node.js dependencies and build static assets:
```bash
yarn install
# for development
yarn watch
# for production
yarn build
```
5. Now you can run the built-in PHP web server
`php -S localhost:8000 -t public`
or use a specialized one, such as nginx or Apache.
Make sure that you point it at the `public/` catalog!
## Tests
Running the test suite:
`php bin/phpunit`