https://github.com/connor-davis/threereco-wil-api
3rEco is an application that allows waste collection recycling businesses to manage their collectors, products and collections easily.
https://github.com/connor-davis/threereco-wil-api
api-rest dotnet-core entityframeworkcore swagger-ui
Last synced: 15 days ago
JSON representation
3rEco is an application that allows waste collection recycling businesses to manage their collectors, products and collections easily.
- Host: GitHub
- URL: https://github.com/connor-davis/threereco-wil-api
- Owner: connor-davis
- Created: 2024-11-10T14:52:12.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-11-12T04:06:52.000Z (6 months ago)
- Last Synced: 2025-03-30T21:51:11.973Z (about 2 months ago)
- Topics: api-rest, dotnet-core, entityframeworkcore, swagger-ui
- Language: C#
- Homepage: https://3reco.co.za
- Size: 27.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 3rEco ASP .NET Core Web API
Welcome to the 3rEco ASP .NET Core Web API! This project has been built with JWT Authentication Logic and CRUD Functionality.
3rEco is an application that allows waste collection recycling businesses to manage their collectors, products and collections easily.
### 🛠️ Technologies Used:
![]()
And we can't forget about EntityFrameworkCore.
### 🚀 Deployment
There are some steps involved to get this API up and running and ready to use.
#### ⬇️ 1. Clone This Repository
```bash
git clone https://github.com/connor-davis/threereco-wil-api
```
#### 📦 2. Dependencies
1. This API uses the PostgreSQL Database to store data.
2. This API uses the .NET 8.0 Runtime with ASP.NET CORE 8.0 Runtime
#### 🧑💻 3. Create The Database
```sql
CREATE DATABASE "whatyouwanttocallit";
```
#### 📐 4. Create The `appsettings.json` File
```json
{
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft.AspNetCore": "Warning"
}
},
"AllowedHosts": "*",
"ConnectionStrings": {
"PostgresDB": "Host=host;Username=username;Password=password;Database=whatyouwanttocallit"
}
}
```
#### 🔨 5. Build The Project
```bash
dotnet build three-api.sln -configuration release
```
Please make sure for this step as well as step 4 that you are in the same folder as this project.
#### 🔒 6. Create Your Admin User
Navigate to the applications url and append /swagger to the end. You will see the Swagger UI. Here you can register your admin user.
#### ✏️ 7. Set Your Admin Users Role
```sql
UPDATE "Users" SET "Roles" = '{0}' WHERE "Email" = 'youradminusersemail';
```
#### ✅ 7. You Are Done
You can now use the admin users login details to remain authenticated and begin playing around with the API.