https://github.com/patrice-h/my-kanban-api
https://github.com/patrice-h/my-kanban-api
api backend nodejs
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/patrice-h/my-kanban-api
- Owner: Patrice-H
- Created: 2022-09-01T13:12:45.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-10T23:11:13.000Z (over 3 years ago)
- Last Synced: 2025-04-07T17:18:52.346Z (about 1 year ago)
- Topics: api, backend, nodejs
- Language: JavaScript
- Homepage:
- Size: 92.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# My Kanban API
- This repo contains the API code you will need to run the My Kanban app.
It goes hand in hand with [the repository of the frontend part](https://github.com/Patrice-H/MyKanban.git).
- This API works with MariaDB [XAMPP Apache + MariaDB](https://www.apachefriends.org/fr/index.html)
## Install the API locally
To install the API locally on your machine, you must :
1. Clone it on your computer `git clone https://github.com/Patrice-H/my-kanban-api.git`
2. Install `node_modules` with `npm install`
3. Run the API with `npm start`
## Consume the API
Once launched, this API makes several routes available to you :
- Route to retrieve all tasks :
`GET /tasks`
- Route to retrieve all details of a task :
`GET /task/?id={id}`
- Route to create a task :
`POST /tasks`
- Route to update a task :
`PUT /task/?id={id}`
- Route to delete a task :
`DELETE /task/?id={id}`
The server should now be running at http://locahost:3001