{"id":26219416,"url":"https://github.com/hngprojects/hng_boilerplate_csharp_web","last_synced_at":"2025-04-06T03:05:20.671Z","repository":{"id":243386921,"uuid":"807567981","full_name":"hngprojects/hng_boilerplate_csharp_web","owner":"hngprojects","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-28T14:04:45.000Z","size":1719,"stargazers_count":80,"open_issues_count":45,"forks_count":58,"subscribers_count":3,"default_branch":"dev","last_synced_at":"2025-03-30T02:03:37.614Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://api-csharp.boilerplate.hng.tech","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hngprojects.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-29T10:55:15.000Z","updated_at":"2025-03-22T01:36:53.000Z","dependencies_parsed_at":"2024-06-08T14:43:28.266Z","dependency_job_id":"44149a43-621c-4869-b5d9-a3e13683fdb4","html_url":"https://github.com/hngprojects/hng_boilerplate_csharp_web","commit_stats":null,"previous_names":["hngprojects/hng_boilerplate_csharp_web"],"tags_count":1,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hngprojects%2Fhng_boilerplate_csharp_web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hngprojects%2Fhng_boilerplate_csharp_web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hngprojects%2Fhng_boilerplate_csharp_web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hngprojects%2Fhng_boilerplate_csharp_web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hngprojects","download_url":"https://codeload.github.com/hngprojects/hng_boilerplate_csharp_web/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247427005,"owners_count":20937200,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-12T14:17:55.457Z","updated_at":"2025-04-06T03:05:20.654Z","avatar_url":"https://github.com/hngprojects.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [Database Schema task] Integration Guide\n\n## Overview\n\n[Description]\n\n## Folder Structure\n\n```\n|--- .vscode\n|--- src\n|    |--- Hng.Application\n|    |--- Hng.Application.Test\n|    |--- Hng.Domain\n|    |--- Hng.Infrastructure\n|    |--- Hng.web\n|         |--- Controllers\n|         |--- Program.cs\n|         |--- .dockerignore\n|         |--- Dockerfile\n|         |--- appsettings.json\n|         |--- appsettings.Development.json\n|--- .gitignore\n|--- Hng.Csharp.Web.sln\n```\n\n## Getting started\n\nEnsure you have your computer setup correctly for development by installing the following\n\n- .Net 8 with C# 12.0\n- Visual studio 2019 or higher with ASP.Net web installation pack or\n- Visual studio code with .Net and C# dev extensions installed\n- Install .Net maui development pack for future uses\n\n## Contribution Guide\n\n#### If you don't have git on your machine, [install it](https://docs.github.com/en/get-started/quickstart/set-up-git).\n\n## Fork this repository\n\nFork this repository by clicking on the fork button on the top of this page.\nThis will create a copy of this repository in your account.\n\n## Clone the repository\n\n\u003cimg align=\"right\" width=\"300\" src=\"https://firstcontributions.github.io/assets/Readme/clone.png\" alt=\"clone this repository\" /\u003e\n\nNow clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the _copy to clipboard_ icon.\n\nOpen a terminal and run the following git command:\n\n```bash\ngit clone \"url you just copied\"\n```\n\nwhere \"url you just copied\" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.\n\n\u003cimg align=\"right\" width=\"300\" src=\"https://firstcontributions.github.io/assets/Readme/copy-to-clipboard.png\" alt=\"copy URL to clipboard\" /\u003e\n\nFor example:\n\n```bash\ngit clone git@github.com:this-is-you/hng_project.git\n```\n\nwhere `this-is-you` is your GitHub username. Here you're copying the contents of the first-contributions repository on GitHub to your computer.\n\n## Create a branch\n\nChange to the repository directory on your computer (if you are not already there):\n\n```bash\ncd hng_project\n```\n\nNow create a branch using the `git switch` command:\n\n```bash\ngit switch -c your-new-branch-name\n```\n\nFor example:\n\n```bash\ngit switch -c add-alonzo-church\n```\n\n### Make Changes\n\nMake your changes to the codebase. Ensure your code follows the project's coding standards and guidelines.\n\n### Run Tests\n\nRun the existing tests to ensure your changes do not break anything. If you added new functionality, write corresponding tests and run them.\n\n## commit those changes\n\nNow open `Contributors.md` file in a text editor, add your name to it. Don't add it at the beginning or end of the file. Put it anywhere in between. Now, save the file.\n\n\u003cimg align=\"right\" width=\"450\" src=\"https://firstcontributions.github.io/assets/Readme/git-status.png\" alt=\"git status\" /\u003e\n\nIf you go to the project directory and execute the command `git status`, you'll see there are changes.\n\nAdd those changes to the branch you just created using the `git add` command:\n\n## Push changes to GitHub\n\nPush your changes using the command `git push`:\n\n```bash\ngit push -u origin your-branch-name\n```\n\nreplacing `your-branch-name` with the name of the branch you created earlier.\n\n\u003cdetails\u003e\n\u003csummary\u003e \u003cstrong\u003eIf you get any errors while pushing, click here:\u003c/strong\u003e \u003c/summary\u003e\n\n- ### Authentication Error\n     \u003cpre\u003eremote: Support for password authentication was removed on August 13, 2021. Please use a personal access token instead.\n  remote: Please see https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/ for more information.\n  fatal: Authentication failed for 'https://github.com/\u003cyour-username\u003e/first-contributions.git/'\u003c/pre\u003e\n  Go to [GitHub's tutorial](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) on generating and configuring an SSH key to your account.\n\n\u003c/details\u003e\n\n## Submit your changes for review into Staging\n\nIf you go to your repository on GitHub, you'll see a `Compare \u0026 pull request` button. Click on that button.\n\n\u003cimg style=\"float: right;\" src=\"https://firstcontributions.github.io/assets/Readme/compare-and-pull.png\" alt=\"create a pull request\" /\u003e\n\nNow submit the pull request.\n\n\u003cimg style=\"float: right;\" src=\"https://firstcontributions.github.io/assets/Readme/submit-pull-request.png\" alt=\"submit pull request\" /\u003e\n\nSoon your changes will be merged into the staging branch of this project. You will get a notification email once the changes have been merged.\n\n## Setup Instructions\n\n### 1. Clone the Repository\n\nFirst, clone the repository to your local machine using Git.\n\n```sh\ngit clone https://github.com/your-username/[app-name].git\ncd [app-name]\n```\n\n### 2. Install Dependencies\n\nOpening the solution in Visual studio should automatically restore all your dependencies, you can ensure this by right clicking on the solution explorer and clicking `Restore dependencies`.\n\nIf you are using Vscode with the required installations mentioned above, navigate to the project directory and install the required dependencies.\n\n```sh\ndotnet restore\n```\n\n### 3. Run the Development Server\n\nPress `F5` on your keyboard to run the application in debug mode for both Visual studio and Vscode (You may need to open a .cs file to trigger this).\n\nAlternatively you can `cd` into `src/Hng.Web` project and run the command\n\n```sh\ndotnet run\n```\n\n### 4. Verify the Setup\n\nDepending on the IDE/code editor, you should be greeted with the Swagger documentation page else navigate to `/swagger` to view the documentation\n\n## Database Connection\nUpdate your appsettings.development file with details of your postgress connection\n\n```\n\"DefaultConnectionString\": \"Server=server-here; Port=5432; Database=UserDb;User Id=postgres;Password=yourpasswordhere\"\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhngprojects%2Fhng_boilerplate_csharp_web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhngprojects%2Fhng_boilerplate_csharp_web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhngprojects%2Fhng_boilerplate_csharp_web/lists"}