Changes between Initial Version and Version 1 of BuildInstructions

Timestamp:

03/24/26 23:24:44 (3 weeks ago)

Author:

211099

Comment:

--

BuildInstructions

@@ +1 @@
+== ChapterX — Setup Instructions
+
+ Clone the Repository from !Github, with command `git clone https://github.com/kristina/chapterx`.
+
+=== Project Structure
+{{{
+chapterX/
+├── chapterx-frontend/        # React + TypeScript frontend
+├── ChapterX.API/             # ASP.NET Core Web API
+├── ChapterX.Application/     # Application layer (MediatR)
+├── ChapterX.Domain/          # Domain entities & interfaces
+└── ChapterX.Infrastructure/  # EF Core, repositories
+
+}}}
+
+=== Database
+
+Before starting the applications, a new database needs to be created and populated with the tables required for the application to work properly.
+
+To create and populate the tables, run the ddl.sql and dml.sql scripts in an appropriate environment such as DBeaver, pgAdmin 4, or similar.
+
+=== Backend
+
+Start the backend
+{{{
+cd ChapterX.API
+
+# Copy the example config and fill in your database credentials and JWT key
+cp appsettings.Development.json.example appsettings.Development.json
+
+# Run the backend
+dotnet run --project ChapterX.API
+}}}
+
+The application should be available at https://localhost:7125.
+
+
+=== Frontend
+
+Start the frontend
+{{{
+cd chapterx-frontend
+
+# Install dependencies and start the app
+npm install
+npm run dev
+}}}
+
+The application should be available at http://localhost:5173.