Project folder organization
- Dominant language
- HTML
- Stars
- 1
- Forks
- 1
- Avg merge
- 1h 53m
- Merged PRs (30d)
- 27
Description
# description
This issue is simple in concept. All the main files like the rendered and all other functions are in 3 files, index.html and app.js and preload.js. Your task is simple, You need to organize the project into directories Meaning each feature that is different needs its own file. Example, All functions that are for the C/C++ language might go in languages/C or languages/C++.
# tasks
- [ ] Look at files.
- [ ] Make directories for each different thing like languages and renderer and backend etc.
- [ ] Move all the respective functions into files in those directories.
- [ ] Add documentation into each directory.
- [ ] Making sure that the program can use the files.
- [ ] Adding new files to manifests and metadata files that index filenames.
# Build Steps
1. Make sure you have node js installed.
2. Make sure you have forked the repo and cloned your fork.
3. Make sure that you have the project open in a terminal or editor with the node js environment variables in them.
First command once all those steps completed is the following:
```dos
npm install
```
This fetches all needed librarys from npm. Please note this is maybe more or up to 1 GB in size. Next you run this command to test your changes:
```dos
npm start
```
Then after that completes with no errors please push and submit a pull request from main repo to your fork.
After you complete this please in the same PR update the file CONTRIBUTORS.md with your details if you would like to be acknowledged
If you encounter any errors please try to resolve them because This project is managed by 1 person.
Contributor guide
Research direction
Start by reading index.html, app.js, and preload.js to map the current rendered, language, backend, and other functions. Run npm install and npm start before and after the reorganization. Done means the functions are separated into appropriate directories with directory documentation, manifests or metadata updated, and the program still starts without errors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- electron, html, javascript, node.js
- Domain
- desktop, tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100