This project is a Web API built using .NET to provide a robust backend for web applications. It leverages the power of ASP.NET Core for creating scalable and maintainable APIs.
Follow these steps to set up and run the project locally.
-
Clone the repository:
git clone https://github.com/KingDavidJnr/basic-web-app-api.git cd basic-web-app-api
-
Create
appsettings.json
:Copy the content from
appsettings.example.json
and save it asappsettings.json
. Fill in the required configuration values. -
Install dependencies:
dotnet restore
-
Build and run the project:
dotnet build dotnet run
Your Web API should now be accessible locally at http://localhost:5000.
Before running the application, ensure you have configured the appsettings.json
file. Below is an example:
{
"AppSettings": {
"ApiKey": "your-api-key",
"DatabaseConnectionString": "your-database-connection-string"
}
}
Replace "your-api-key"
and "your-database-connection-string"
with your actual API key and database connection string.
Make sure to add and commit the appsettings.json
file to your local repository. The .gitignore
file is configured to ignore this file, as well as the obj/
and bin/
directories.
We welcome contributions to enhance the functionality and features of this Web API. To contribute:
- Fork the repository.
- Create a new branch for your feature:
git checkout -b feature-name
. - Make your changes and commit them:
git commit -m "Add your feature"
. - Push to your branch:
git push origin feature-name
. - Create a pull request.