Moose Planner API

Moose Planner is an API developed in Flask that provides a platform for organized folder and task management. This API allows users to efficiently structure and manage their tasks, dividing them into folders for better organization and accessibility.

📋 Contents

• Features
• Tech used
• How to get the project:
  • Using Git (recommended)
  • Using manual download ZIP
  • Using docker
• Deploy in render
• API endpoints
  • Indication
  • User related
  • Folders related
  • Tasks related

Features

🔒 Authentication

• Registration of accounts.
• Login and closing.
• Refreshment of tokens.

📂 Folders Management

• Create, update and delete folders.
• See folder details.

✅ Task Management

• Create tasks associated with folders.
• View, update and delete tasks.

Tech used

Programming language

• Python

Framework

• Flask

Database

• MongoDB

Container

• Docker

How to get the project

Using Git (recommended)

1. Navigate & open CLI into the directory where you want to put this project & Clone this project using this command.

git clone https://github.com/Carril-fol/restful-organizer.git

Using manual download ZIP

1. Download repository
2. Extract the zip file, navigate into it & copy the folder to your desired directory

Using docker

1. Open Docker Desktop
2. Navigate & open CLI of your preference & use this command.

docker pull carrilfol/restful-organizer

3. Now you need to run the image you just downloaded in docker, with the following command

docker run -p [PORT TO EXPOSE]:5000 carrilfol/restful-organizer

Deploy in render

You can access the live version of the application here and make requests from Postman or Insomnia.

Note: The server may take time to start because it is hosted on the free layer.

API endpoints

Indication

• Authentication required
• Authentication not required

User related

• Register: POST localhost:[PORT]/users/api/v1/register
• Login: POST localhost:[PORT]/users/api/v1/login
• Logout: POST localhost:[PORT]/users/api/v1/logout
• Get user info: GET localhost:[PORT]/users/api/v1/detail
• Refresh token: POST localhost:[POST]/users/api/v1/refresh

Folders related

• Create a folder: POST localhost:[PORT]/folders/api/v1/create
• Get all folder from a user: GET localhost:[PORT]/folders/api/v1/user/<user_id>
• Detail from a folder: GET localhost:[PORT]/folders/api/v1/<folder_id>
• Delete a folder: DELETE localhost:[PORT]/folders/api/v1/<folder_id>
• Update a folder: PUT localhost:[PORT]/folders/api/v1/<folder_id>

Tasks related

• Create a task: POST localhost:[PORT]/tasks/api/v1/<folder_id>
• Detail from a tasks: GET localhost:[PORT]/tasks/api/v1/<task_id>/
• Update a task: PUT localhost:[PORT]/tasks/api/v1/<task_id>
• Delete a task: DELETE localhost:[PORT]/tasks/api/v1/<task_id>