QuickBotAppFrontend
This project was generated with Angular CLI version 15.1.3.
Development server
Run ng serve for a dev server. Navigate to http://localhost:4200/. The application will automatically reload if you change any of the source files.
Code scaffolding
Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.
Build
Run ng build to build the project. The build artifacts will be stored in the dist/ directory.
Running unit tests
Run ng test to execute the unit tests via Karma.
Running end-to-end tests
Run ng e2e to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
Further help
To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.
Code Styling & Commit Guidelines
To maintain code quality and consistency:
- TypeScript (Frontend): We follow Angular Coding Style Guide by leveraging the use of Google's TypeScript Style Guide using
gts. This includes a formatter, linter, and automatic code fixer. - Python (Backend): We adhere to the Google Python Style Guide, using tools like
pylintandblackfor linting and formatting. - Commit Messages: We suggest following Angular's Commit Message Guidelines to create clear and descriptive commit messages.
Frontend (TypeScript with gts)
- Initialize
gts(if not already done in the project): Navigate to thefrontend/directory and run:This will set upnpx gts initgtsand create necessary configuration files (liketsconfig.json). Ensure yourtsconfig.json(or a related gts config file like.gtsrc) includes an extension forgtsdefaults, typically:{ "extends": "./node_modules/gts/tsconfig-google.json", // ... other configurations } - Check for linting issues:
(This assumes a
npm run lintlintscript is defined inpackage.json, e.g.,"lint": "gts lint") - Fix linting issues automatically (where possible):
(This assumes a
npm run fixfixscript is defined inpackage.json, e.g.,"fix": "gts fix")
Backend (Python with pylint and black)
- Ensure Dependencies are Installed:
Add
pylintandblackto yourbackend/requirements.txtfile:Then install them within your virtual environment:pylint blackpip install pylint black # or pip install -r requirements.txt - Configure
pylint: It's recommended to have a.pylintrcfile in yourbackend/directory to configurepylintrules. You might need to copy a standard one or generate one (pylint --generate-rcfile > .pylintrc). - Check for linting issues with
pylint: Navigate to thebackend/directory and run:(Or specify modules/packages:pylint .pylint your_module_name) - Format code with
black: To automatically format all Python files in the current directory and subdirectories:python -m black . --line-length=80