-
-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
bf07acd
commit 2be9efc
Showing
38 changed files
with
13,195 additions
and
473 deletions.
There are no files selected for viewing
43 changes: 43 additions & 0 deletions
43
...le-App/platforms/android/app/src/main/assets/www/StickyNotes-Frontend/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# StickyNotes App - Frontend | ||
|
||
The `src` directory is the main hub for the application's frontend resources, including HTML pages, CSS stylesheets, and JavaScript files. It's organized to separate concerns and enhance maintainability. | ||
|
||
## Structure | ||
|
||
- `css`: This folder contains cascading style sheets for the application's styling. | ||
- `style.css`: The main stylesheet that defines the look and feel of the application. | ||
|
||
- `html`: Contains the HTML files, which are the building blocks of the application's content. | ||
- `about.html`: Provides information about the application and its usage. | ||
- `calendar.html`: Implements the calendar feature of the application, allowing users to manage events and notes. | ||
- `privacy-policy.html`: Contains the privacy policy for the application. | ||
- `inspiration.html`: Displays inspirational quotes to motivate users. | ||
- `create-account.html`: Allows users to create an account to save their notes and settings. | ||
- `sign-in.html`: Provides a login form for users to access their accounts. | ||
|
||
- `js`: Holds the JavaScript files that add interactivity to the application. | ||
- `script.js`: The main script file that contains logic for dynamic behavior and client-side functionality. | ||
- `quotes.js`: Contains functions to fetch and display inspirational quotes on the `inspiration.html` page. | ||
- `reset-password.js`: Implements the password reset functionality for users. | ||
- `sign-in.js`: Handles user authentication and login functionality. | ||
- `create-account.js`: Manages user registration and account creation. | ||
|
||
## Guidelines | ||
|
||
- **CSS**: When adding new styles, ensure they are responsive and consistent with existing styling rules. Use classes instead of IDs for styling to maintain a clean and reusable codebase. | ||
|
||
- **HTML**: HTML files should be well-structured and semantic. Use proper indentation and comments to enhance readability. | ||
|
||
- **JavaScript**: Keep the code modular and avoid global variables where possible. Comment on complex logic for better understanding and maintenance. | ||
|
||
## Best Practices | ||
|
||
- Test your changes in multiple browsers to ensure cross-browser compatibility. | ||
- Minify CSS and JavaScript files before deploying to production to improve load times. | ||
- Validate HTML for accessibility to ensure the application is usable by all users. | ||
|
||
## Contributions | ||
|
||
To contribute to this directory, please fork the repository, make your changes, and submit a pull request with a description of the updates. Ensure that your code follows the outlined guidelines and best practices. | ||
|
||
For any questions or issues, please open an issue in the repository, and I will address it promptly. |
Oops, something went wrong.