📓 PlanZap 📓

View Demo · Report Bug · Request Feature

🌟 Index

• About the Project
• Built With
• Structure
• Live Site
• Getting Started
• Prerequisites
• Installation and Setup
• Contributing
• Roadmap
• Things that can be improved
• Code of Conduct
• How to resolve merge conflicts
• Contributing using Github Desktop
• Open Source Participation
• Contributors
• Project Admin

🌟 About The Project

A productivity cum utility based open source application, where users can keep an eye on their tasks update their progress , maintain a watchlist for movies, books , 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.

🌟 Installation and Setup

1. Navigate to the project directory

cd PlanZap

2. In the project directory, navigate to "Backend" directory

cd Backend

3. In the Backend directory, install the packages using

npm install

4. Now move out of the Backend directory, to the project directory using

cd ..

5. In the project directory, navigate to "Frontend" directory

cd Frontend

6. In the Frontend directory, install the packages using

npm install

7. Once all the packages are installed, run the app on your local server using

npm 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.

🌟 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. To contribute to this project you first need to fork this repository Fork this repository. To fork it click on the fork

2. Clone your forked copy of the project. To clone open git bash in your device and type the following command

git clone https://github.com/<your github username>/PlanZap.git

3. Now open git bash in cloned repository folder

4. Add a reference(remote) to the original repository.

git remote add upstream https://github.com/SaraswatGit/PlanZap.git

5. Check the remotes for this repository.

git remote -v

6. Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).

git pull upstream main

7. Create a new branch.

git checkout -b <your_branch_name>

8. Perform your desired changes to the code base.

9. Track your changes:heavy_check_mark: .

git add .

10. Commit your changes .

git commit -m "Relevant message"

11. Push the committed changes in your feature branch to your remote repo.

git push -u origin <your_branch_name>

12. To create a pull request, click on compare and pull requests. Please ensure you compare your feature branch to the desired branch of the repository you are supposed to make a PR to.

13. Add appropriate title and description to your pull request explaining your changes and efforts done.

14. Add a screenshot or screen-recording when submitting a PR.

15. Click on Create Pull Request.

🌟 Roadmap

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

Things that can be improved

• On login page confirm password and password don't yet have matching ability
• Improving 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

🌟 Code of Conduct

• Only npm should be used for managing packages.
• Only the libraries with 1000+ downloads per week should be used.
• Spamming issues may lead to banning user from contributing to the project.
• No disrespectful comments towards any gender, sex, caste or nationality will be tolerated.

🌟 How to resolve merge conflicts

• Conflicts generally arise when two people have changed the same lines in a file, or if one developer deleted a file while another developer was modifying it. In these cases, Git cannot automatically determine what is correct. Conflicts only affect the developer conducting the merge, the rest of the team is unaware of the conflict. Git will mark the file as being conflicted and halt the merging process. It is then the developers' responsibility to resolve the conflict.

• The most direct way to resolve a merge conflict is to edit the conflicted file

• Git commands that can help resolve merge conflicts :-

  1 .The status command is in frequent use when a working with Git and during a merge it will help identify conflicted files.

  2 . Passing the --merge argument to the git log command will produce a log with a list of commits that conflict between the merging branches.

  

  3 . diff helps find differences between states of a repository/files. This is useful in predicting and preventing merge conflicts.

  

  • If above are not resolving your issue you can checkout this url

🌟 Contributing using Github Desktop

Use this method if you have github desktop downloaded.

1. Fork this repository by clicking on the fork. Forking would create a copy of this repository so you can make changes freely without affecting the original repository.

2. Open you github desktop, go to file and click on clone repository .

3. Choose the forked repository from the options and click on clone.

4. Then click "to contribute on the parent project" option and then continue

5. Make a new branch by Clicking on Current Branch, then click on new branch.

6. Give your branch a new name.

7. Click on "open in visual studio code" option. This would create a new workspace in your vsc.

8. Make the changes you want to make and save. For example the one below:

9. Now go back to the github desktop and you will automatically see the changes.

10. Add the title of your change and description and commit.

11. Now click on publish branch.

12. Now click on create pull request.This will redirect you to the github website where you can see your changes. Click on "create pull request" .

13. Your work is now done, wait for the creater to merge your changes. Happy contributing! :))

🌟 Open Source Participation

This project is a part of these Open Source Programs

🌟 Contributors

Thanks to these wonderful people ✨✨:

🌟 Project Admin

  

Back to Top^