Skip to content

Project folder organization #4

Description

@gtref

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:

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:

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.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    improvmentfeatures/improvements needed

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions