Skip to content

Commit d1bd600

Browse files
committed
docs: updated README.md
1 parent 7e2ace5 commit d1bd600

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@ Admin Hub API serves as the core backend infrastructure for managing multiple ad
3434

3535
1. Clone the repository
3636
```bash
37-
git clone https://github.com/your-username/admin-hub-api.git
37+
git clone https://github.com/design-sparx/admin-hub-api.git
3838
cd admin-hub-api
3939
```
4040

4141
2. Update the connection string in `appsettings.json`
4242
```json
4343
{
4444
"ConnectionStrings": {
45-
"DefaultConnection": "Server=your-server;Database=AdminHubDB;Trusted_Connection=True;"
45+
"DefaultConnection": "Data Source={{PC-NAME}}\\SQLEXPRESS;Initial Catalog={{DB-NAME}};Integrated Security=True;Connect Timeout=30;Encrypt=False;TrustServerCertificate=False;ApplicationIntent=ReadWrite;MultiSubnetFailover=False"
4646
}
4747
}
4848
```
@@ -54,22 +54,26 @@ dotnet ef database update
5454

5555
4. Start the application
5656
```bash
57-
dotnet run
57+
dotnet watch run
5858
```
5959

6060
## Project Structure
6161

6262
```
6363
admin-hub-api/
64-
├── src/
65-
│ ├── AdminHub.API/ # API project
66-
│ ├── AdminHub.Core/ # Business logic and domain models
67-
│ ├── AdminHub.Data/ # Data access layer
68-
│ └── AdminHub.Common/ # Shared utilities and helpers
64+
├── AdminHubApi/
65+
│ ├── Controllers/
66+
│ ├── Data/
67+
│ ├── Dtos/
68+
│ └── Extensions/
69+
│ └── Helpers/
70+
│ └── Interfaces/
71+
│ └── Mappers/
72+
│ └── Migrations/
73+
│ └── Models/
74+
│ └── Repository/
75+
│ └── Service/
6976
├── tests/
70-
│ ├── AdminHub.API.Tests/
71-
│ ├── AdminHub.Core.Tests/
72-
│ └── AdminHub.Data.Tests/
7377
└── docs/ # Additional documentation
7478
```
7579

@@ -81,7 +85,7 @@ API documentation is available via Swagger UI at `/swagger` when running the app
8185

8286
1. Fork the repository
8387
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
84-
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
88+
3. Commit your changes (`git commit -m 'feat:Add some AmazingFeature'`)
8589
4. Push to the branch (`git push origin feature/AmazingFeature`)
8690
5. Open a Pull Request
8791

0 commit comments

Comments
 (0)