Skip to content

Latest commit

 

History

History
55 lines (50 loc) · 2.15 KB

README.md

File metadata and controls

55 lines (50 loc) · 2.15 KB
Raw

Crocus Backend

Crocus allows you to keep a to-do list online and shared on different platforms.

Documentation

View Online Documentation on Postman Documenter

API Roadmap

You can follow the project progress on this list.

  • General
    • HTTP Server
    • Database Connect
    • Middlewares
    • Error Handling
    • E-mail Template
    • E-mail Sender on SMTP
  • Models
    • User: name, surname, email, password, photo, create_date, reset_password_key, reset_password_expire_date
    • List: name, color, owner_user, shared_users
    • Task: title, content, create_date, expire_date, complate, list
    • Share: sender, receiver, list, status, sending_date
  • Routes/Controllers
    • Auth [/auth]
      • Register (post) [/register]
      • Login (post) [/login]
      • Logout (get) [/logout]
      • Check Auth (get, protect) [/check]
      • Forgot Password (post) [/forgotpassword]
      • Reset Password (post) [/resetpassword]
    • User [/user]
      • Update Details (put, protect) [/details]
      • Update Password (put, protect) [/password]
      • Update Profile Photo (put, protect) [/photo]
    • List [/list]
      • My Lists (get, protect) [/]
      • Add List (post, protect) [/]
      • List Details with Tasks (get, protect) [/:listId]
      • Update List Details (put, protect) [/:listId]
      • Delete List (delete, protect) [/:listId]
      • Remove User from List (delete, protect) [/:listId/:userId]
      • Sent Requests for List (get, protect) [/:listId/requests]
    • Task [/task]
      • My All Tasks (get, protect) [/]
      • Add Task (post, protect) [/]
      • Task Details (get, protect) [/:taskId]
      • Update Task (put, protect) [/:taskId]
      • Detele Task (delete, protect) [/:taskId]
      • List Upcoming Tasks (get, protect) [/upcoming]
    • Share [/share]
      • List Requests (get, protect) [/]
      • Send Request (post, protect) [/]
      • Reply Request (put, protect) [/:requestId]
      • Delete Sended Request (delete, protect) [/:requestId]