Giter Club home page Giter Club logo

hngx's Introduction

HNGx Backend Project 2

.NET Version Docker Version Render Hosted

Overview

This is the HNGx Backend Project 2, a RESTful API built using C# and .NET 7 Minimal API framework. It provides endpoints to manage a list of persons, allowing you to perform basic CRUD operations (Create, Read, Update, Delete) on person records. The API is containerized with Docker and hosted on Render, making it easy to deploy and scale.

Getting Started

To run this project locally or deploy it on your own server, follow these steps:

  1. Prerequisites:

  2. Configure the PostgreSQL database connection: Update the database connection string in the appsettings.json file to point to your PostgreSQL database.

  3. Clone the Repository:

    git clone https://github.com/richkazz/HNGx.git
    cd HNGx
  4. Build and Run Locally:

    dotnet build
    dotnet run
  5. Access the API:

    The API should now be running locally at http://localhost:8080/api.

API Documentation

For detailed information on the API endpoints and how to use them, please refer to the API Documentation.

Docker Containerization

This project is Dockerized, allowing for easy deployment and scaling. To build a Docker image and run it locally, follow these steps:

  1. Build the Docker Image:

    docker build -t hngx.
  2. Run the Docker Container:

    docker run -p 8080:80 hngx

    The API will be accessible at http://localhost:8080/api.

Deployment on Render

To deploy this project on Render, follow these steps:

  1. Create a Render Account:

    If you haven't already, sign up for a Render account at https://render.com/.

  2. Create a New Web Service:

    • Choose "Docker" as the environment.
    • Link your GitHub repository.
    • Configure the build settings and environment variables as needed.
  3. Deploy the Service:

    Render will automatically build and deploy your Docker container. Once deployed, your API will be accessible at the provided URL.


hngx's People

Contributors

richkazz avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.