Documentation: Dev - afsnippet/afsnippet GitHub Wiki
| CORE: | Project | Tests | Design | Performance | Security |
|---|
| EPICS: | Infrastructure | Registration | Authentication | Snippets | Extra |
|---|
CORE 🚧
Project
Code of Conduct
Our Pledge
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
Our Standards
Examples of behavior that contributes to creating a positive environment include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
Scope
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [INSERT EMAIL ADDRESS]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
Attribution
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4
Contributing
The guide for contributing to this project is located here please take a moment to read it fully before submitting a contribution - thank you.
TDD
JSDoc/TSDoc
Specs Documentation
Each feature of the application has an area in the specs documentation. When you're developing a feature, or creating one - you'll need to reference/add content to this area.
Dev Documentation
As you code out a feature, note down your approach - explaining why you choose the approach/tools you did.
Tests
Summary: Tests
A brief paragraph summarizing the approach for tests in this project.
Unit Tests
There is a test.spec.ts file inside src/app.
This imports all the necessary services and components so you can just import the export getBasicTestBed method in the spec file you're working in - this is for front-end UI only and not the admin section.
There is a separate test file in src/app/ui/admin-section named admin-test.spec.ts.
It serves the same purpose, to import all the needed services and components so you can just import the exported method, getAdminTestBed into the spec file you're working on.
Backend Tests
Jest content here...
E2E Tests
Cypress is the selected tool for end-to-end testing.
https://docs.cypress.io/guides/overview/why-cypress.html#
Continuous Integration
CI strategy content here..
Firestore Security Rules
Firestore Security Rules content here...
Tools
wallaby content here..
Design
Summary: Design
content here..
Material Design
content here..
CSS Grid
content here..
Themes
content here..
PWA
content here..
Media Queries
The three screen sizes are: 1200px, 768px, 480px
Example
@media (max-width: 1200px) {
grid-template-columns: 1fr 1fr 1fr;
}
@media (max-width: 768px) {
grid-template-columns: 1fr 1fr;
}
@media (max-width: 480px) {
grid-template-columns: 1fr;
}
}
Performance
Summary: Performance
content here..
Security
Summary: Security
content here..
EPICS 💡
100: Infrastructure
Summary: Infrastructure
This application uses Angular, Firebase and Google Cloud Functions. Organization private key information is stored in the environment variables of Google Cloud Fn.
code for correct syntax for adding org data to cloud fn here...
101: Registration
Summary: Registration
registration content here
102: Authentication
Summary: Authentication
By default this application accepts user login from insert
Github Login
content here...
103: Snippets
Summary: Snippets
content here...
104: Extra
Summary: Extra
content here...