This is an API that provides resources for a Kanban Board. The API provides endpoints that lets users manage resources such as Boards, Lists, Cards -- similar to what Trello does behind the scene.
- A user creates a token by using registration or login endpoints
- The user can then perform CRUD operations on Board, List, Card by using the token with the appropriate endpoints and method calls.
ROOT_URL
= https://murmuring-brushlands-24573.herokuapp.com/
Methods | PATH | Description |
---|---|---|
POST | /register/ | Registers a new user to obtain token |
POST | /login/ | Login in an existing user to obtain token |
GET | /auth-user/ | Return current user |
Ensure to pass in the token in the
Authorization
header for the requests
Methods | PATH | Description |
---|---|---|
GET | /boards/ | Get the list of boards |
POST | /boards/ | Create a new board |
GET | /boards/<id> / |
Get a single board with the given Id |
PUT | /boards/<id> / |
Update the board with the given id |
DELETE | /boards/<id> / |
Delete the board with the given id |
POST | /lists/ | Create a new list |
POST | /cards/ | Create a new card |
PUT | /cards/<id> |
Edit a card with the given id |
DELETE | /cards/<id> / |
Delete the card with the given id |
- Python 3.8
- Django 3.2.5
- Django Rest Framework 3.12.4
- Postgresql
To get a local copy up and running follow these simple steps.
In order for Kanban-Board
to work locally on your machine, you need these installations:
- Python 3.8
- Postgres database engine
- Open the Terminal
- Activate a virtual environment for the project
- Run
git clone https://github.com/belsman/Kanban-Board.git
or, for SSH:
git clone [email protected]:belsman/Kanban-Board.git
- Run
cd Kanban-Board
to enter the main directory - Run ```pip install``
- Setup the database
- Use
CREATE DATABASE database_name;
to create the DB in your database's interactive prompt - Edit the
DATABASES
settings variable in thesettings.py
file to match your configuration e.g.ENGINE
USER
,PASSWORD
, andNAME
- Use
- Run database migrations with these command:
python manage.py makemigrations board
python manage.py migrate
- Start up the local server with
python manage.py runserver
👤 Bello Babakolo
- Github: @belsman
- Twitter: @d_belsman
- Linkdin: Bello Babakolo
Contributions, issues and feature requests are welcome!
Feel free to check the issues page.
Give a ⭐️ if you like this project!