Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/venkateshramkumarg/pintrest-backend_
This project offers a RESTful API for image management. Create, retrieve, and delete images with titles and URLs. Search images by title and manage them efficiently using tools like Postman. Runs on Node.js and MongoDB.
https://github.com/venkateshramkumarg/pintrest-backend_
honojs mongodb mongoose typescript
Last synced: 13 days ago
JSON representation
This project offers a RESTful API for image management. Create, retrieve, and delete images with titles and URLs. Search images by title and manage them efficiently using tools like Postman. Runs on Node.js and MongoDB.
- Host: GitHub
- URL: https://github.com/venkateshramkumarg/pintrest-backend_
- Owner: venkateshramkumarg
- License: mit
- Created: 2024-08-13T06:15:33.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-21T22:42:14.000Z (3 months ago)
- Last Synced: 2024-10-04T22:10:51.795Z (about 1 month ago)
- Topics: honojs, mongodb, mongoose, typescript
- Language: TypeScript
- Homepage:
- Size: 29.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pinterest API
Welcome to the Pinterest API. This application allows users to create, retrieve, and delete images through a RESTful API
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [API Endpoints](#api-endpoints)
- [Create Image](#create-image)
- [Get Images](#get-images)
- [Delete Image](#delete-image)
- [Environment Variables](#environment-variables)
- [License](#license)
## Installation
1. Clone the repository:
```sh
git clone https://github.com/venkateshramkumarg/Pintrest-Backend_
cd todo
```
2. Install dependencies:
```sh
npm install
```
3. Start the application:
```sh
npm start
```
## Usage
The application runs on `http://localhost:3000/api`. You can use tools like Postman or curl to interact with the API.
## API Endpoints
### Create Image
- **Create Image**
```http
POST /api/createImage
```
**Request Body:**
```json
{
"title": "image_title",
"imageUrl": "image_url"
}
```
### Get Images
- **Get Images**
```http
GET /api/getImages
```
- **Search Image**
```http
POST /api/getImages/search/image
```
**Request Body:**
```json
{
"searchTitle": "search_title"
}
```
### Delete Image
- **Delete Image**
```http
DELETE /api/deleteImage/:id
```
## Environment Variables
Create a [`.env`](command:_github.copilot.openRelativePath?%5B%7B%22scheme%22%3A%22file%22%2C%22authority%22%3A%22%22%2C%22path%22%3A%22%2Fc%3A%2FVS%20CODE%2FNodeJS%2Ftodo%2F.env%22%2C%22query%22%3A%22%22%2C%22fragment%22%3A%22%22%7D%5D "c:\\VS CODE\\NodeJS\\todo.env") file in the root directory and add the following environment variables:
```env
PORT=3000
URI=your_mongodb_uri
```
## Licence
This project is licensed under the MIT License.