https://github.com/yunkhngn/sao-ke-api
A simple API for searching for transactions from nhà tài trợ
https://github.com/yunkhngn/sao-ke-api
Last synced: 3 months ago
JSON representation
A simple API for searching for transactions from nhà tài trợ
- Host: GitHub
- URL: https://github.com/yunkhngn/sao-ke-api
- Owner: yunkhngn
- License: mit
- Created: 2024-09-13T06:55:29.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-13T07:06:04.000Z (9 months ago)
- Last Synced: 2025-01-31T01:54:45.739Z (5 months ago)
- Language: JavaScript
- Homepage: https://soundke-api.vercel.app
- Size: 6.3 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sao kê API 💸
> Currently working right now!
### A simple API for searching for transactions from nhà tài trợ
*Author: @yunkhngn*
## Quick start
```javascript
fetch("https://soundke.vercel.app/api/")
.then(function (response) {
return response.json();
})
.then(function (response) {
//extract data
})
.catch(function (error) {
// handle what went wrong
});
```
## Documentation
| GET path | Result| Params|
| :------------ | ---------- | :----------- |
| `/api/`| test for api| |
| `/api/search/:keywork` | return data with keyword include `name` | `'/khoa-nguyen'`,`'/phuong-hang'`... |
**JSON format:**
```json
{
"date":"Date of transaction",
"trans_no":"Transaction number",
"credit":"Value",
"debit":"Value",
"detail":"Transaction detail",
}
```
## Local development
1. Clone this repository and install dependencies locally.
```sh
git clone https://github.com/yunkhngn/sao-ke-api.git
```
2. Then
```sh
cd sao-ke-api
cd api
yarn install
#or npm install
node index.js
```
3. Install nodemon (optional for hot reload)
```sh
yarn add nodemon
nodemon index.js
```
## License & contributions
Contributions to Repository are welcome! To contribute, please follow these steps:
1. Fork the repository
2. Create a new branch for your feature or fix
3. Make changes and commit them to your branch
4. Submit a pull request to the main repository.
Sao ke API's Repository is licensed under the GNU License. See LICENSE for more information.