https://github.com/rabbihossainlhp/mobileapp_api
basic api with db like mysql
https://github.com/rabbihossainlhp/mobileapp_api
api appapi backend
Last synced: 3 months ago
JSON representation
basic api with db like mysql
- Host: GitHub
- URL: https://github.com/rabbihossainlhp/mobileapp_api
- Owner: rabbihossainlhp
- Created: 2025-01-13T10:33:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-18T15:25:05.000Z (over 1 year ago)
- Last Synced: 2025-01-28T23:17:21.757Z (over 1 year ago)
- Topics: api, appapi, backend
- Language: JavaScript
- Homepage: https://mobileappapi-production.up.railway.app/
- Size: 1.32 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MobileApp_API
This project is a basic API with MySQL database integration.
## Project Summary
This project provides a basic API that interacts with a MySQL database. It includes CRUD operations for managing data.
## Key Features
- Basic API setup with Node.js and Express
- MySQL database integration
- CRUD operations (Create, Read, Update, Delete)
## Setup Instructions
### Prerequisites
- Node.js installed
- MySQL database setup
### Installation
1. Clone the repository:
```sh
git clone https://github.com/rabbihossainlhp/MobileApp_API.git
# District Information API
This is a simple API for managing district information. It allows you to create, update, retrieve, and delete district information.
## Table of Contents
- [Installation](#installation)
- [Environment Variables](#environment-variables)
- [Running the API](#running-the-api)
- [API Endpoints](#api-endpoints)
- [Error Handling](#error-handling)
## Installation
1. Clone the repository:
```bash
git clone https://github.com/your-username/your-repo-name.git
cd your-repo-name
2. Install the dependencies:
```bash
npm install
3. environment variable should like this:
```bash
DB_HOST=your_database_host
DB_USER=your_database_user
DB_PASSWORD=your_database_password
DB_NAME=District_Info
DB_PORT=3306
PORT=3535
# Replace the placeholder values with your actual database credentials.
##Running the API
1. Start the server:
```bash
npm start
2. The server will be running at http://localhost:3535.
## API Endpoints
The live API is hosted at: https://mobileappapi-production.up.railway.app/
Create a District
URL: /api/create-item
Method: POST
Body:
{
"name": "District Name",
"description": "District Description"
}
Response:
201 Created
500 Internal Server Error
Get single Items
URL: /api/singleitem/:id
Method: GET
Response:
201 Created
404 Not Found
500 Internal Server Error
Update single Items
URL: /api/updateitem/:id
Method: POST
Body:
{
"name": "District Name",
"description": "District Description"
}
Response:
201 Updated
404 Not Found
500 Internal Server Error
Delete single Items
URL: /api/updateitem/:id
Method: POST
Body:
{
"name": "District Name",
"description": "District Description"
}
Response:
201 Deleted
404 Not Found
Get all Items
URL: /api/allitem/
Method: GET
Response:
201 SuccessFully founded all info
404 Not Found