| Backend | ||
| Frontend/plannerly | ||
| README.md | ||
Plannerly
Problem Statement
Task management can be overwhelming, often lacking a user-friendly and comprehensive solution. Users struggle with disorganized to-do lists, prioritization difficulties, and a lack of analytics to track their productivity.Plannerly
It is a user-friendly todo app designed to simplify task organization. Users can effortlessly add tasks, prioritize them as urgent or regular, and benefit from comprehensive analytics. Plannerly is the go-to productivity tool, offering an efficient solution for streamlined and effective task management.
Table of Contents
There are many great README templates available on GitHub;however, I didn't find one that really suited my needs so I created this one. I wanted to create a README template which satisfies the project.
Here's why:
- A project that solves a problem and helps others.
- One shouldn't be doing the same task over and over like creating a README from scratch.
- You should implement DRY principles to the rest of your life 😄
Of course, no one template will serve all projects since your needs may be different. So i'll be adding more in the near future.You may also suggest changes by forking this repo and creating a pull request or opening issue. Thanks to all the people have contributed to expanding this template!
About The Project
LegalEdge is a flutter application which uses firebase to sign in users and create a new account. With the help of our Node.js backend we have integrated the functionalities of registering users, lawyers , creating posts , liking a post and also commenting on the posts.
Built With
This section should list any major frameworks/libraries used to bootstrap your project.Leave any add-ons/plugins for the acknowledgement section. Here are a few examples.
Getting Started
We recommend creating a new flutter project using 'flutter create --org project_name' , which sets up a default application setup automatically. To create a project, run the followingf command in cmd after downloading and sucessfully installing flutter:
'flutter create --org project_name'
Prerequisites
After the installation is complete:
In the main file try running with the run without debugging:
A few resources to get you started if this is your first Flutter project:
For help getting started with Flutter development, view the online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.
Installation
Below is an example of how you can instruct your audience on installing and setting up your app.This template doesn't rely on any external dependencies or services.
1.Clone the repo
git clone https://github.com/Uttkarsh-raj/Plannerly
2.Install the packages
flutter pub get
Setup backend
Setup the repo in your local system
git clone https://github.com/Uttkarsh-raj/Legal-Edge.git
Create a .env file in the Backend folder of the project and add the following
PORT=8000
MONGODB_URL="<Your_Mongodb_Url_Here>"
SECRET_KEY= "<Your_Secret_Key_Here>"
Run the following commands next
go run main.go
The server has started and ready to send and receive requests. Next, head to the Frontend/Plannerly/lib/utils/server/server_constants.dart and add these changes
var baseUrl = "http://your_id_address_here:8000";
Now you are ready to run the project locally.
Routes
1. User Routes
POST '/user/signup'
- Send {first_name,last_name,email,password,phone} as Request body
- Responds as {success:true,data:documentId}
POST '/user/login'
- Send {email,password} as Request body
- Responds with {success:true , data: UserObject}
2. Task Routes
POST '/addTask'
- Send { user_id,title,desc,time,date,status} as Request body
- Responds as {success:true, data:TaskObject}
PATCH '/update/:id'
- Send {first_name,last_name,email,password,phone,or any params you want to change} as Request body
- Responds as {success:true,data:documentId}
GET '/getTasks'
- Responds as {success:true, data:TaskObjects}
GET '/getTask/:id'
- Responds as {success:true, data:TaskObject}
GET '/tasks/urgent'
- Responds as {success:true, data:TaskObject}
GET '/tasks/regular'
- Responds as {success:true, data:TaskObject}
DELETE '/delete/:id'
- Responds as {success:true, data:TaskObject}
POST '/search'
- Send {search} as Request body
- Responds as {success:true, data:TaskObject}
Usage
-
Adding Tasks:
- Problem: Users face challenges in organizing their tasks efficiently.
- Solution: With Plannerly, users can easily add tasks, ensuring a clear and organized to-do list.
-
Prioritization:
- Problem: Users struggle to prioritize tasks, leading to confusion.
- Solution: Plannerly allows users to categorize tasks as urgent or regular, aiding in effective prioritization.
-
Comprehensive Analytics:
- Problem: Lack of insights into task completion and productivity.
- Solution: Plannerly provides comprehensive analytics, enabling users to track their productivity and make informed decisions.
Screenshots:
Login and Signup Screens:
Other ScreenShots:
Roadmap
- Add Changelog
- Add back to top links
- Add Additional Templates w/ Examples
- Add "components" document to easily copy & paste sections of the readme
- Multi-language Support
- Hindi
- English
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire ,and create.Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Contact
Uttkarsh Raj - https://github.com/Uttkarsh-raj
Acknowledgments
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!