A RESTful API built using ASP.NET Core and PostgreSQL
Head over to the download section of the .NET Website and download the SDK for your operating system. Go ahead and run through the installer.
Make sure the CLI tools work by running dotnet --version in your terminal
Go to the download section on the PostgreSQL website and download the installer appropriate for your OS. Run through the installer, and don't worry about having to install anything extra if it prompts you.
Use your operating system's search function to find and run PGAdmin. Log into PGAdmin using the password you setup during installation to confirm everything installed correctly.
First, clone the repository:
git clone https://github.com/Capstone-Codefucius/codefucius-api.git
Next, run the following command to make sure the necessary packages are installed:
dotnet restore
Navigate to the appsettings.json file in the project, and you'll notice the following connection string:
"Server=localhost;Port=5432;Database=codefucius;User Id=postgres;Password=password;"
This will need to be modified. You can either use:
- The default postgres user, with the password you created during installation
- Create a new user id and password
Replace the user id and password where necessay. This is needed to connect to the database.
The EF Core CLI tool is needed for this step, which can be installed with the following command:
dotnet tool install --global dotnet-ef
First, you need to make a migration to create a schema for the database:
dotnet ef migrations add initial
This needs to be done whenever the models are changed. Replace intial with whatever you want to name the migration.
Finally, apply this schema to the database with the following command.
dotnet ef database update
First, make sure that PGAdmin/Postgres is running so the API can connect to the databse.
To start the API, run
dotnet run
And press CTRL-C to stop it.
For interacting with the API on its own, I would highly recommend using Postman.