https://github.com/mhaidarhanif/mytasks-api
MyTasks API
https://github.com/mhaidarhanif/mytasks-api
api backend mytasks
Last synced: 24 days ago
JSON representation
MyTasks API
- Host: GitHub
- URL: https://github.com/mhaidarhanif/mytasks-api
- Owner: mhaidarhanif
- License: mit
- Created: 2018-08-03T04:04:37.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-06T13:39:02.000Z (almost 8 years ago)
- Last Synced: 2025-01-14T00:47:06.459Z (over 1 year ago)
- Topics: api, backend, mytasks
- Language: JavaScript
- Homepage: https://mytasks-api.mhaidarhanif.com
- Size: 86.9 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# MyTasks API
A simple task management API
Try MyTasks API version »
Report bug ·
Request feature ·
Author ·
Company
## Features
- Get all tasks
- Get one task by id
- Create new task
- Search existing task
- with query
- with request body
---
## REST API Specification
| Endpoint | HTTP | Description |
| --------------- | -------- | ---------------------- |
| `/tasks` | `GET` | Get all tasks |
| `/tasks/:id` | `GET` | Get one task |
| `/tasks` | `POST` | Create new task |
| `/tasks` | `DELETE` | Destroy all tasks |
| `/tasks/:id` | `DELETE` | Destroy one task |
| `/tasks/:id` | `PUT` | Update one task |
| `/tasks/search` | `GET` | Search task with query |
---
## Development
### Node.js
```sh
npm install
npm run dev
```
```sh
> mytasks-api@x.y.z dev /home/username/path/to/mytasks-api
> node-dev index
MyTasks API is listening on localhost:3000
```
Access the app on `localhost:3000` via:
- `curl`:
- `httpie`:
- `postman`:
- `insomnia`:
---
## Production
```sh
npm install
npm start
```
---
## Deployment
### Heroku
```sh
heroku create
git push heroku master
heroku open
```
or
[](https://heroku.com/deploy)
---
## Meta
### License
[MIT License](./LICENSE)
### Code of Conduct
[Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md)
