File tree Expand file tree Collapse file tree 1 file changed +61
-0
lines changed
Expand file tree Collapse file tree 1 file changed +61
-0
lines changed Original file line number Diff line number Diff line change 1+ # TaskMaster API
2+
3+ TaskMaster API is a powerful ASP.NET Core Web API project designed for managing tasks efficiently.
4+
5+ ## Features
6+
7+ - ** Task Management:** Create, update, delete, and retrieve tasks.
8+ - ** Authentication:** Secure endpoints using JWT-based authentication.
9+ - ** Database:** Utilizes SQL Server for data storage.
10+
11+ ## Technologies Used
12+
13+ - ASP.NET Core
14+ - Entity Framework Core
15+ - SQL Server
16+ - JWT Authentication
17+
18+ ## Getting Started
19+
20+ ### Prerequisites
21+
22+ - [ .NET 6 SDK] ( https://dotnet.microsoft.com/download/dotnet/6.0 )
23+ - SQL Server
24+
25+ ### Installation
26+
27+ 1 . Clone the repository:
28+ ``` bash
29+ git clone https://github.com/chenxidev1129/taskmaster-api.git
30+
31+ 2. Navigate to the project directory:
32+ ` ` ` bash
33+ cd taskmaster-api
34+
35+ 4. Update the connection string:
36+ - Open *** appsettings.json*** and replace the *** ConnectionStrings*** with your SQL Server connection details:
37+ ` ` ` json
38+ " ConnectionStrings" : {
39+ " DefaultConnection" : " Server=ADMIN\\ SQL2022;Database=TaskMaster;Integrated Security=true;"
40+ }
41+
42+ 6. Run the migration to apply the database schema:
43+ ` ` ` bash
44+ dotnet ef database update --context TaskMasterDbContext
45+
46+ 8. Run the application:
47+ ` ` ` bash
48+ dotnet run
49+
50+ # # API Endpoints
51+ - ** GET /api/tasks:** Retrieve all tasks.
52+ - ** GET /api/tasks/{id}:** Retrieve a specific task by ID.
53+ - ** POST /api/tasks:** Create a new task.
54+ - ** PUT /api/tasks/{id}:** Update an existing task.
55+ - ** DELETE /api/tasks/{id}:** Delete a task by ID.
56+
57+ # # Contributing
58+ Contributions are welcome! Please follow the guidelines outlined in CONTRIBUTING.md.
59+
60+ # # License
61+ This project is licensed under the MIT License.
You can’t perform that action at this time.
0 commit comments