Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thareendra2000/boostmoods-backend
https://github.com/thareendra2000/boostmoods-backend
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/thareendra2000/boostmoods-backend
- Owner: Thareendra2000
- Created: 2024-08-24T12:28:02.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-24T12:35:41.000Z (3 months ago)
- Last Synced: 2024-09-08T16:54:49.372Z (about 2 months ago)
- Language: C#
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# BoostMoods
BoostMoods is a simple backend API designed to deliver a variety of uplifting compliments through a single endpoint.
## Tech Stack
- **Framework**: ASP.NET Core
- **Language**: C#
## Prerequisites
Ensure you have the following installed:
- [.NET SDK](https://dotnet.microsoft.com/download) (version 6.0 or later)
- [Visual Studio](https://visualstudio.microsoft.com/) or [Visual Studio Code](https://code.visualstudio.com/)
## Setup Instructions
### Clone the Repository
First, clone the repository:
```bash
git clone https://github.com/yourusername/boostmoods.git
cd boostmoods
```
### Install Dependencies
Restore the project dependencies by running:
```bash
dotnet restore
```
### Build the Project
Compile the project using:
```bash
dotnet build
```
### Run the Project
Start the application with:
```bash
dotnet run
```
By default, the API will be available at `http://localhost:5000`.
### Accessing the API
The API exposes a single endpoint:
- **Endpoint**: `GET /compliment`
- **Description**: Retrieves a random compliment.
- **Response**: A string containing a compliment.
#### Example Request
Use a tool like [Postman](https://www.postman.com/) or [cURL](https://curl.se/) to test the endpoint:
```bash
curl http://localhost:5000/compliment
```
---