Skip to content

Commit

Permalink
Adjusted readme + badges.
Browse files Browse the repository at this point in the history
  • Loading branch information
koencaerels committed Jan 17, 2024
1 parent 8a0d3f2 commit c386b00
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
Yoshi-Kan Website + Ledenbeheer
===============================

---

<p style="padding-top:9px;">
<img src="https://img.shields.io/github/license/koencaerels/yoshikan?style=flat" alt="GitHub license">
<img src="https://github.com/koencaerels/yoshikan/actions/workflows/php_build_and_qa_test.yml/badge.svg">
</p>

---

## Requirements

...

## Getting Started

### 1. Make a valid .env file
Expand All @@ -16,10 +29,10 @@ so no modifications needed.
The docker scripts include automatic download and installation for following
parts of the project:
* composer install for the php libraries (vendor folder)
* webpack: symfony webpack encore installation & production build
* vuePress: installation & production build (docs)
* webpack: symfony webpack encore installation & production build*
* vue 3: **member_module** installation & production build
(disabled for now due to some permission problem when running it in dev mode)
* (disabled for now due to some permission problem when running it in dev mode)
* vuePress: installation & production build (docs)

#### These are available services:
* Website: http://localhost:8080
Expand All @@ -40,7 +53,7 @@ php bin/console doctrine:database:create
php bin/console doctrine:schema:update --force
```

## Futher reference
## Further reference

You can consult documentation site for extended information
http://localhost:8081

0 comments on commit c386b00

Please sign in to comment.