Skip to content

Commit

Permalink
Update gitignore and dev guide
Browse files Browse the repository at this point in the history
  • Loading branch information
garrettmflynn committed May 22, 2024
1 parent dd806bb commit 678f1d6
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 11 deletions.
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,13 @@ coverage
node_modules
build/api
src/pyflask/ds
src/Users
semantic
semantic.json
.env
build/
yarn.lock

*.pyc
src/.DS_Store
.DS_Store
electron-builder.yml
website/.eslintcache
Expand Down
23 changes: 14 additions & 9 deletions docs/developer_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,15 +83,20 @@ You can now run the following command to start the application using Electron.
Repo Structure
--------------
1. **src/electron/renderer/src** - Contains all the source code for the frontend
- `index.js` - The entry point for the application
- `pages.js` - The main code that controls which pages are rendered and how they are linked together
- `stories` - Contains all the Web Components and related Storybook stories
- `electron` - Contains all the Electron-related code to enable conditional inclusion for development mode
2. **src/electron/renderer/assets** - Contains all the frontend-facing assets (e.g. images, css, etc.)
3. **pyflask** - Contains all the source code for the backend


- `src`
- `electron`
- `main`
- `src` - Contains all the source code for the backend
- `assets` - Contains all the backend-facing assets (e.g. images, css, etc.)
- `renderer`
- `src` - Contains all the source code for the frontend
- `index.js` - The entry point for the application
- `pages.js` - The main code that controls which pages are rendered and how they are linked together
- `stories` - Contains all the Web Components and related Storybook stories
- `electron` - Contains all the Electron-related code to enable conditional inclusion for development mode
- `assets` - Contains all the frontend-facing assets (e.g. images, css, etc.)
- `pyflask` - Contains all the source code for the backend
- `schemas` - Contains all the JSON schemas used for validation


Starting a New Feature
Expand Down

0 comments on commit 678f1d6

Please sign in to comment.