Skip to content

ScreTask API For Task Management Related Stuff. Developers may utilise this API to support the backend of their apps by coding them in the tech stack of their choosing.

Notifications You must be signed in to change notification settings

Dev-Adnani/ScreTask-Backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ScreTask

  • ScreTask API For Task Management Related Stuff. Developers may utilise this API to support the backend of their apps by coding them in the tech stack of their choosing.

Tech Stack

Database : MongoDB

Server : Node, Express , TypeScript

Frontend : Flutter App

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

PORT

MONGODB_URL

JWT_SECRET

CUSTOM_EMAIL

CUSTOM_PASS

Run Locally

Clone the project

  git clone https://github.com/Dev-Adnani/ScreTask-Backend

Go to the project directory

  cd ScreTask-Backend

Install dependencies

  npm i

Start the server

  npm run dev

API Reference

Authentication

Send Email Verification

  POST /auth/send-email-verification
Parameter Type Description
useremail string Required. User's Email

Sign Up

  POST auth/signup
Parameter Type Description
useremail string Required. User's Email
userpassword string Required. User's Password
username string Required. User's Name
userphoto string Required. User's Profile URL
secretcode string Required. Secret Code Generated By Server
secretcodeinput string Required. Secret Code Enterted By User

Login

  POST /auth/login
Parameter Type Description
useremail string Required. User's Email
userpassword string Required. User's Password

Decode User Data

  GET /auth/verify
Parameter Type Description
tokenData authorization Required. JWT

Tasks

Add Tasks

  POST task/add
Parameter Type Description
user_id string Required. User's ID
task_title string Required. Task's Title
task_desc string Required. Task's Description
task_type string Required. Task's Types
task_date string Required. Task's Date
task_completed boolean Required. Task's Completed Status

Get Tasks

  GET task/:userId
Parameter Type Description
userId Parameter Required. User's ID

Get Completed Task Count

  GET task/count/:userId
Parameter Type Description
userId Parameter Required. User's ID

Get Detail Task [Particular Task]

  GET task/detail/:taskId
Parameter Type Description
task_id Parameter Required. Task ID

Get Categories Type Of Task

  POST task/taskType
Parameter Type Description
task_type string Required. Task Types
user_id string Required. User's ID

Update Tasks

  PUT task/update
Parameter Type Description
task_id Parameter Required. Task ID
task_title string Required. Task's Title
task_desc string Required. Task's Description
task_type string Required. Task's Types
task_date string Required. Task's Date
task_completed boolean Required. Task's Completed Status

Delete Task

  DELETE task/delete/:taskId
Parameter Type Description
task_id Parameter Required. Task ID

Authors

Feedback

If you have any feedback, please reach out to us at devadnani26@gmail.com

License

MIT

About

ScreTask API For Task Management Related Stuff. Developers may utilise this API to support the backend of their apps by coding them in the tech stack of their choosing.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published