From 678f1d6c4b26a16303ed80918ba5cc7944c073ee Mon Sep 17 00:00:00 2001 From: Garrett Michael Flynn Date: Wed, 22 May 2024 10:15:05 -0700 Subject: [PATCH] Update gitignore and dev guide --- .gitignore | 2 -- docs/developer_guide.rst | 23 ++++++++++++++--------- 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/.gitignore b/.gitignore index f830102b2..865e043ba 100644 --- a/.gitignore +++ b/.gitignore @@ -14,7 +14,6 @@ coverage node_modules build/api src/pyflask/ds -src/Users semantic semantic.json .env @@ -22,7 +21,6 @@ build/ yarn.lock *.pyc -src/.DS_Store .DS_Store electron-builder.yml website/.eslintcache diff --git a/docs/developer_guide.rst b/docs/developer_guide.rst index c003e3328..208b730ce 100644 --- a/docs/developer_guide.rst +++ b/docs/developer_guide.rst @@ -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