https://github.com/dacmarcell/devstackapi
An API for managing software portfolio profiles. Users can add or remove social media links, posts, and projects. Designed for beginner programmers to learn API consumption while building their profiles.
https://github.com/dacmarcell/devstackapi
asp-net-core azure c-sharp entity-framework sql-server-database
Last synced: 3 months ago
JSON representation
An API for managing software portfolio profiles. Users can add or remove social media links, posts, and projects. Designed for beginner programmers to learn API consumption while building their profiles.
- Host: GitHub
- URL: https://github.com/dacmarcell/devstackapi
- Owner: dacmarcell
- License: mit
- Created: 2024-12-22T03:11:07.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-16T00:14:50.000Z (4 months ago)
- Last Synced: 2025-01-16T00:57:06.604Z (4 months ago)
- Topics: asp-net-core, azure, c-sharp, entity-framework, sql-server-database
- Language: C#
- Homepage:
- Size: 960 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
❯ DevStack API
## 🔗 Table of Contents
- [📍 Overview](#-overview)
- [👾 Features](#-features)
- [🚀 Getting Started](#-getting-started)
- [☑️ Prerequisites](#-prerequisites)
- [🤖 Usage](#🤖-usage)
- [🧪 Testing](#🧪-testing)
- [📌 Project Roadmap](#-project-roadmap)
- [🔰 Contributing](#-contributing)
- [🎗 License](#-license)
---
## 📍 Overview
Showcase your profile with simplicity and professionalism using our API!
Whether you're a beginner programmer looking to explore API consumption or someone aiming to create a centralized and functional portfolio, our API is the perfect choice.
With it, you can:
✅ Add and remove social media links, posts, and projects to your profile;
✅ Organize your portfolio efficiently and with a personal touch;
✅ Learn how to consume APIs while building something real for your professional growth.
Perfect for beginners!
Easily implement it into your applications and start experiencing the power of APIs in the development world.
---
## 👾 Features
❯Create a profile
❯Add or remove a post to profile
❯Add or remove a project to profile
❯Add or remove a social media to profile
---
## 📁 Project Structure
```sh
└── DevStackAPI/
├── Controllers
│ ├── PostController.cs
│ ├── ProfileController.cs
│ ├── ProjectController.cs
│ └── SocialMediaController.cs
├── Database
│ └── ApplicationDBContext.cs
├── Dtos
│ ├── PostDtos
│ ├── ProfileDtos
│ ├── ProjectDtos
│ └── SocialMediaDtos
├── Enums
│ ├── ConnectOrDisconnect.cs
│ └── SocialMediaNames.cs
├── Migrations
│ ├── ...
├── Models
│ ├── Post.cs
│ ├── Profile.cs
│ ├── Project.cs
│ └── SocialMedia.cs
├── Program.cs
├── Properties
│ └── launchSettings.json
├── appsettings.Development.json
├── appsettings.json
├── compose.yml
├── portfolio-api.csproj
├── portfolio-api.http
├── portfolio-api.sln
└── start-dev.sh
```
---
## 🚀 Getting Started
### ☑️ Prerequisites
Before getting started with DevStackAPI, ensure your runtime environment meets the following requirements:
- **Programming Language:** CSharp
- **Package Manager:** Nuget
### ⚙️ Installation
Install portfolio-api using one of the following methods:
**Build from source:**
1. Clone the portfolio-api repository:
```sh
❯ git clone https://github.com/dacmarcell/DevStackAPI
```
2. Navigate to the project directory:
```sh
❯ cd DevStackAPI
```
3. Install the project dependencies:
**Using `nuget`** [
](https://docs.microsoft.com/en-us/dotnet/csharp/)
```sh
❯ dotnet restore
```
### 🤖 Usage
Run portfolio-api using the following command:
**Using `nuget`** [](https://docs.microsoft.com/en-us/dotnet/csharp/)
```sh
❯ dotnet run
```
### 🧪 Testing
Run the test suite using the following command:
**Using `nuget`** [](https://docs.microsoft.com/en-us/dotnet/csharp/)
```sh
❯ dotnet test
```
---
## 📌 Project Roadmap
- [X] **`Task 1`**: Finish business rule.
- [ ] **`Task 2`**: Prettify Code.
- [ ] **`Task 3`**: Implement Cache.
- [ ] **`Task 4`**: Deploy to Azure.
---
## 🔰 Contributing
- **💬 [Join the Discussions](https://github.com/dacmarcell/DevStackAPI/discussions)**: Share your insights, provide feedback, or ask questions.
- **🐛 [Report Issues](https://github.com/dacmarcell/DevStackAPI/issues)**: Submit bugs found or log feature requests for the `DevStackAPI` project.
- **💡 [Submit Pull Requests](https://github.com/dacmarcell/DevStackAPI/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.
Contributing Guidelines
1. **Fork the Repository**: Start by forking the project repository to your github account.
2. **Clone Locally**: Clone the forked repository to your local machine using a git client.
```sh
git clone https://github.com/dacmarcell/DevStackAPI
```
3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.
```sh
git checkout -b new-feature-x
```
4. **Make Your Changes**: Develop and test your changes locally.
5. **Commit Your Changes**: Commit with a clear message describing your updates.
```sh
git commit -m 'Implemented new feature x.'
```
6. **Push to github**: Push the changes to your forked repository.
```sh
git push origin new-feature-x
```
7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. **Review**: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
Contributor Graph
---
## 🎗 License
This project is protected under the [MIT](https://choosealicense.com/licenses/mit/) License. For more details, refer to the [LICENSE](https://choosealicense.com/licenses/) file.
---