Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code Cleanup: Organising folder structure into frontend, backend and README #82

Closed
pranavajith opened this issue Oct 11, 2024 · 11 comments
Labels
good first issue Good for newcomers gssoc-ext GSSoC'24 Extended hacktoberfest-accepted hacktoberfest 2024 level1 gssoc: level 1 Up To Grab

Comments

@pranavajith
Copy link

Is your feature request related to a problem? Please describe.

The README.md seems to indicate that the folder structure is as follows
PassOP/
├── backend/ # Backend Node.js application
│ ├── server.js # Main server file
│ ├── .env # Environment configuration (not included in repo)
│ ├── package.json # Backend dependencies
│ └── ... # Other backend files
├── frontend/ # React frontend application (using Vite)
│ ├── src/ # React components and files
│ ├── public/ # Public static files
│ ├── package.json # Frontend dependencies
│ └── vite.config.js # Vite configuration file
├── README.md # This file
└── ...

Whereas, currently that is not the case. This caused me a lot of confusion initially, and I'd imagine it is the same for many people.

Describe the solution you'd like
I would like to first organise the files into frotnend and backend folder, and then update the README to match this.

Describe alternatives you've considered
We could simply change the README to fit the current structure,, but the current structure is not the most widely seen uniform seperation of concerns of frontend and backend, and so it is not ideal.

Additional context
Will add any that is needed by admin. As of now, seems self explanatory.

Copy link

👋 Thank you for raising an issue! We appreciate your effort in helping us improve. Our team will review it shortly. Stay tuned!

@pranavajith
Copy link
Author

@jinx-vi-0 Do you mind setting up relevant labels and assigning it to me? Although I have some experience in dev, It's always been solo projects, never really open source. Looking forward to do my best here!

@sudo-dpkg
Copy link
Owner

Okay, sounds good! Just make sure to check every endpoint and configuration to ensure everything works perfectly. Also, please update the README to reflect any changes you make. Looking forward to your contributions!

@sudo-dpkg sudo-dpkg added good first issue Good for newcomers gssoc-ext GSSoC'24 Extended hacktoberfest-accepted hacktoberfest 2024 level1 gssoc: level 1 labels Oct 12, 2024
@pranavajith
Copy link
Author

pranavajith commented Oct 12, 2024

Will do!
In the meantime, wanted to ask if .env being in backend folder is required. Isn't it supposed to be in gitignore?
Also, as a follow up, isn't there supposed to be a single gitingore? Why does there seem to be 2?

@jinx-vi-0

@sudo-dpkg
Copy link
Owner

Yeah, add the .env to gitignore and create an example.env to help contributors understand the .env structure.

@pranavajith
Copy link
Author

pranavajith commented Oct 15, 2024

@jinx-vi-0 is there any issue with the export option? It doesn't seem to work. I reverted all my changes, but it still seems to not respond?

@pranavajith
Copy link
Author

@jinx-vi-0
Also... noted a major issue in backend.

The download doesn't happen cause of the following reason. In server.js,

image

This expects id as a parameter. Which means anything after "http://localhost:3000/" will be seen as the id parameter. Hence when we try to export passwords, it is unable to reach the handler:

image

Leading to error.

Check it out yourself. Once you comment out the /:id handler, the export option works. This is a major backend flaw. Would you like me to make an issue for the same?

@sudo-dpkg
Copy link
Owner

@pranavajith create an issue. I'll assign it to you.

@jindalpriyanshu101
Copy link
Contributor

Hi, @pranavajith what's the progress status on this issue?

@jindalpriyanshu101
Copy link
Contributor

Marked as Up-To-Grab since there's no update yet.

@112201007
Copy link

@jinx-vi-0 Could you please assign this to me? I’ve been exploring open source projects, and I’ll do my best to contribute and resolve it.

@sudo-dpkg sudo-dpkg closed this as not planned Won't fix, can't repro, duplicate, stale Nov 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers gssoc-ext GSSoC'24 Extended hacktoberfest-accepted hacktoberfest 2024 level1 gssoc: level 1 Up To Grab
Projects
None yet
Development

No branches or pull requests

4 participants