/PlanZap

An App to maintain your tasks , personal diary , notes , movie list everything at one place!

Primary LanguageJavaScriptMIT LicenseMIT


๐Ÿ““ PlanZap ๐Ÿ““

PlanZap logo



๐ŸŒŸ About The Project

A productivity cum utility based application, where users can keep an eye on their tasks update their progress , maintain a watchlist for movies , personal diary as well as notes.

๐ŸŒŸ Built With

  • HTML
  • CSS
  • React
  • Material UI
  • REST APIs

๐ŸŒŸ Structure

  • A side navbar with the fixed position, that render everytime a new section is clicked, in the area beside it- refered to as "routearea" in the app
  • All CSS of all files is present in the CSS components file
  • useContext has been used to get access to userid , login status etc.

Live site

Have a look here on the live site.

๐ŸŒŸ Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • You need to install Node js to successfully run this project on your local machine.

๐ŸŒŸ Contributing

  1. Fork the project first

  2. Clone the forked repo

    git clone https://github.com/<your_user_name>/PlanZap.git
  3. Navigate to the project directory

    cd PlanZap
  4. In the project directory, install the packages using

    npm install
  5. Run the app on your local server using

    npm run start

Open http://localhost:3000 or http://localhost:3001 to view it in the browser. The page will reload if you make edits.
You will also see any lint errors in the console.

๐ŸŒŸ Roadmap

See the open issues for a list of proposed features . Feel free to raise new issues.

Thnigs that can be improved

  • On login page confirm password and password don't yet have matching ability
  • Improing the UI of the login page
  • Implementing responsiveness
  • Improving the Modals (that pops up to create new movie entry or new diary entry)
  • Improving the User experience of the Personal Diary

๐ŸŒŸ 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.

  1. Fork the Project

  2. Create your Feature Branch

    git checkout -b <your_branch_name>
  3. Perform your desired changes to the code base

  4. Add your Changes

    git add .
  5. Commit your Changes

    git commit -m "Relevent message"
  6. Push to the Branch

    git push origin <your_branch_name>
  7. Open a Pull Request by ading appropriate Title and Description

๐ŸŒŸ Open Source Participation

This project is a part of these Open Source Programs


๐ŸŒŸ Contributors

Thanks to these wonderful people โœจโœจ:

๐ŸŒŸ Project Admin