diff --git a/README.md b/README.md index aba23fe..5ecd4bc 100644 --- a/README.md +++ b/README.md @@ -15,96 +15,113 @@ Please refer to our [Style Guide](https://git.kjan.de/SZUT/casino/wiki/Frontend# ## Tech Stack ### Frontend -- Angular 19 + +- Angular 20 - TailwindCSS - Keycloak integration - Stripe payment integration ### Backend + - Spring Boot (Java) - PostgreSQL database - Keycloak for authentication/authorization - Stripe API for payment processing ### Infrastructure + - Docker containerization for all services ## Getting Started ### Prerequisites -* [Docker](https://docs.docker.com/get-docker/) -* [Docker Compose](https://docs.docker.com/compose/install/) (included with Docker Desktop for Windows and Mac) -* Java JDK 17+ -* Node.js 18+ + +- [Docker](https://docs.docker.com/get-docker/) +- [Docker Compose](https://docs.docker.com/compose/install/) (included with Docker Desktop for Windows and Mac) +- Java JDK 17+ +- Node.js 18+ ### Setting Up the Environment 1. Clone the repository + ```bash git clone cd casino ``` 2. Start the Docker services + ```bash cd docker docker-compose up -d ``` This will start: + - PostgreSQL database - Keycloak authentication server ### Running the Backend 1. Navigate to the backend directory + ```bash cd backend ``` 2. Start the Spring Boot application + ```bash ./gradlew bootRun ``` You may optionally install [watchexec](https://github.com/watchexec/watchexec?tab=readme-ov-file) and use this command to autorecompile the backend on file changes: + ```bash watchexec -r -e java ./gradlew :bootRun ``` The backend will be available at: -- API endpoint: http://localhost:8080 -- Swagger documentation: http://localhost:8080/swagger + +- API endpoint: +- Swagger documentation: ### Running the Frontend 1. Navigate to the frontend directory + ```bash cd frontend ``` 2. Install dependencies + ```bash npm install ``` 3. Start the development server + ```bash npm run dev ``` -The frontend will be available at http://localhost:4200 +The frontend will be available at ### Local Stripe integration + 1. Install the Stripe CLI - https://stripe.com/docs/stripe-cli + 2. Login to the casino stripe account + ``` stripe login --api-key ``` 3. Start webhook forwarding + ``` stripe listen --forward-to localhost:8080/webhook ``` @@ -114,6 +131,7 @@ stripe listen --forward-to localhost:8080/webhook ### Postgres Management #### Database cleanup (if needed) + ```bash cd docker docker-compose down @@ -122,6 +140,7 @@ docker-compose up -d ``` #### Setting up IntelliJ Database View + 1. Run the Docker container with PostgreSQL database 2. Open `application.properties` in the resources folder and copy the database URL 3. Open the Database tab in IntelliJ @@ -148,6 +167,7 @@ We follow semantic commit messages to maintain clear project history. Format: `(): ` Where `` is one of: + - `feat`: New feature - `fix`: Bug fix - `docs`: Documentation changes @@ -157,6 +177,7 @@ Where `` is one of: - `chore`: Updating build tasks, etc; no production code change Examples: + ``` feat: add user balance display fix(auth): resolve token expiration issue @@ -164,6 +185,7 @@ docs: update API documentation ``` References: + - [Conventional Commits](https://www.conventionalcommits.org/) - [Semantic Commit Messages](https://seesparkbox.com/foundry/semantic_commit_messages)