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

Issue: Improve File Structure for LisBook Project #10

Open
Ctoic opened this issue Oct 1, 2024 · 9 comments
Open

Issue: Improve File Structure for LisBook Project #10

Ctoic opened this issue Oct 1, 2024 · 9 comments

Comments

@Ctoic
Copy link
Owner

Ctoic commented Oct 1, 2024

The current file structure of the LisBook project can be improved to enhance organization and ease of navigation for contributors. A well-structured project makes it easier for beginners to understand the application flow and locate files.

Proposed Changes:

Create a /src directory to contain all source files, including:

A /css folder for stylesheets.
A /js folder for JavaScript files.
An /img folder for images and icons.
The main index.html file.
Introduce an /assets directory for static assets, such as:

A /fonts folder for custom fonts.
A /media folder for additional audio files or media.
Create a /docs directory for documentation files, including:

CONTRIBUTING.md for contribution guidelines.
README.md for project overview and instructions.
LICENSE for license information.
Add a .gitignore file to exclude unnecessary files from the Git repository.

Benefits:

Improves organization and readability of the project.
Facilitates easier contributions from new developers.
Enhances the scalability of the project as it grows.
Acceptance Criteria:

Implement the proposed file structure.
Ensure all existing files are moved to their new locations without breaking functionality.
Update any file references in the code accordingly.

@VaradJadhav
Copy link
Contributor

hey @Ctoic please assign this issue to me.

@Ctoic
Copy link
Owner Author

Ctoic commented Oct 1, 2024

Sure will assign the issue do follow the best practises to complete the task. Happy coding :)

@dheerajsingh01
Copy link

hey @Ctoic is this issue still open . if yes then do assign me.
I will structure the file.
I can a include folder with footer.html and navbar.html which is totally empty.
I can make it more readable.

@Ctoic
Copy link
Owner Author

Ctoic commented Oct 6, 2024

Best of luck and do your best 👍🏼 I hope you will get your 4 pull request merge from here and complete hacktoberfest

@sAchin-680
Copy link

Hi @Ctoic, I would like to work on this issue and improve the file structure as proposed. Could you please assign it to me? Thanks!

@Ctoic
Copy link
Owner Author

Ctoic commented Oct 16, 2024

Make sure it works afer deployment @sAchin-680

@Ctoic
Copy link
Owner Author

Ctoic commented Oct 16, 2024

Go Ahead @sAchin-680

@sAchin-680
Copy link

Make sure it works afer deployment @sAchin-680

Thank you for the feedback, @Ctoic !

I will ensure that all changes are thoroughly tested after deployment to verify that the project works as expected with the new file structure. I'll also double-check all file references and asset loading to avoid any issues.

Please feel free to let me know if there are any additional details or requirements you'd like me to consider during this process.

@sAchin-680
Copy link

Hi @Ctoic , I’ve just committed changes (c7b61f0) that refactor the project structure for better organization. Key updates include:
New directories for source files, assets, and documentation.
Added a .gitignore file to clean up the repository.

Let me know your thoughts!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants