Skip to content

Commit 4e74c18

Browse files
authored
Update README
Updated instructions for cloning the repository and added steps for running the backend locally, including starting the local dev database and Azurite.
1 parent 06651e2 commit 4e74c18

1 file changed

Lines changed: 51 additions & 5 deletions

File tree

README.md

Lines changed: 51 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,62 @@ Autobank is a Kotlin Spring Boot application designed for managing financial rec
88

99
1. **Clone the repository**
1010
```bash
11-
git clone https://github.com/appKom/gnocchitony.git
12-
cd gnocchitony
11+
git clone https://github.com/appKom/Autobank-backend.git
12+
cd Autobank-backend
1313
```
1414

1515
2. **Configure environment variables**
1616

1717
3. **Run the application**
18-
```bash
19-
./gradlew bootRun
20-
```
18+
### Running the backend locally
19+
20+
#### 1. Start the local dev database
21+
22+
Make sure Docker is running, then run:
23+
24+
```bash
25+
docker compose up -d
26+
```
27+
28+
#### 2. Start Azurite
29+
30+
Azurite is used as a local Azure Storage emulator.
31+
32+
First, try:
33+
34+
```bash
35+
azurite --loose --skipApiVersionCheck --location ~/.azurite
36+
```
37+
38+
If `azurite` is not available as a command, check where global npm packages are installed:
39+
40+
```bash
41+
npm prefix -g
42+
```
43+
44+
Example output when using `nvm`:
45+
46+
```bash
47+
/Users/<username>/.nvm/versions/node/v22.13.0
48+
```
49+
50+
Then run Azurite directly from the `bin` folder:
51+
52+
```bash
53+
~/.nvm/versions/node/v22.13.0/bin/azurite --loose --skipApiVersionCheck --location ~/.azurite
54+
```
55+
56+
If Azurite is not installed, install it globally:
57+
58+
```bash
59+
npm install -g azurite
60+
```
61+
62+
#### 3. Start the backend
63+
64+
```bash
65+
./gradlew bootRun
66+
```
2167

2268
The application will start on `http://localhost:8080`
2369

0 commit comments

Comments
 (0)