53 |
54 |
55 |
56 | WriteGen
57 |
58 |
59 | {'Your own personal writer!'}
60 |
61 |
62 | {'WriteGen uses AI to write passages for you. But it needs your help! '}
63 | {'Type in some text below and press submit to see your short story!'}
64 |
65 |
66 |
67 |
68 |
69 |
80 |
98 | );
99 | }
--------------------------------------------------------------------------------
/src/serviceWorker.js:
--------------------------------------------------------------------------------
1 | // This optional code is used to register a service worker.
2 | // register() is not called by default.
3 |
4 | // This lets the app load faster on subsequent visits in production, and gives
5 | // it offline capabilities. However, it also means that developers (and users)
6 | // will only see deployed updates on subsequent visits to a page, after all the
7 | // existing tabs open on the page have been closed, since previously cached
8 | // resources are updated in the background.
9 |
10 | // To learn more about the benefits of this model and instructions on how to
11 | // opt-in, read https://bit.ly/CRA-PWA
12 |
13 | const isLocalhost = Boolean(
14 | window.location.hostname === 'localhost' ||
15 | // [::1] is the IPv6 localhost address.
16 | window.location.hostname === '[::1]' ||
17 | // 127.0.0.0/8 are considered localhost for IPv4.
18 | window.location.hostname.match(
19 | /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/
20 | )
21 | );
22 |
23 | export function register(config) {
24 | if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) {
25 | // The URL constructor is available in all browsers that support SW.
26 | const publicUrl = new URL(process.env.PUBLIC_URL, window.location.href);
27 | if (publicUrl.origin !== window.location.origin) {
28 | // Our service worker won't work if PUBLIC_URL is on a different origin
29 | // from what our page is served on. This might happen if a CDN is used to
30 | // serve assets; see https://github.com/facebook/create-react-app/issues/2374
31 | return;
32 | }
33 |
34 | window.addEventListener('load', () => {
35 | const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`;
36 |
37 | if (isLocalhost) {
38 | // This is running on localhost. Let's check if a service worker still exists or not.
39 | checkValidServiceWorker(swUrl, config);
40 |
41 | // Add some additional logging to localhost, pointing developers to the
42 | // service worker/PWA documentation.
43 | navigator.serviceWorker.ready.then(() => {
44 | console.log(
45 | 'This web app is being served cache-first by a service ' +
46 | 'worker. To learn more, visit https://bit.ly/CRA-PWA'
47 | );
48 | });
49 | } else {
50 | // Is not localhost. Just register service worker
51 | registerValidSW(swUrl, config);
52 | }
53 | });
54 | }
55 | }
56 |
57 | function registerValidSW(swUrl, config) {
58 | navigator.serviceWorker
59 | .register(swUrl)
60 | .then(registration => {
61 | registration.onupdatefound = () => {
62 | const installingWorker = registration.installing;
63 | if (installingWorker == null) {
64 | return;
65 | }
66 | installingWorker.onstatechange = () => {
67 | if (installingWorker.state === 'installed') {
68 | if (navigator.serviceWorker.controller) {
69 | // At this point, the updated precached content has been fetched,
70 | // but the previous service worker will still serve the older
71 | // content until all client tabs are closed.
72 | console.log(
73 | 'New content is available and will be used when all ' +
74 | 'tabs for this page are closed. See https://bit.ly/CRA-PWA.'
75 | );
76 |
77 | // Execute callback
78 | if (config && config.onUpdate) {
79 | config.onUpdate(registration);
80 | }
81 | } else {
82 | // At this point, everything has been precached.
83 | // It's the perfect time to display a
84 | // "Content is cached for offline use." message.
85 | console.log('Content is cached for offline use.');
86 |
87 | // Execute callback
88 | if (config && config.onSuccess) {
89 | config.onSuccess(registration);
90 | }
91 | }
92 | }
93 | };
94 | };
95 | })
96 | .catch(error => {
97 | console.error('Error during service worker registration:', error);
98 | });
99 | }
100 |
101 | function checkValidServiceWorker(swUrl, config) {
102 | // Check if the service worker can be found. If it can't reload the page.
103 | fetch(swUrl, {
104 | headers: { 'Service-Worker': 'script' },
105 | })
106 | .then(response => {
107 | // Ensure service worker exists, and that we really are getting a JS file.
108 | const contentType = response.headers.get('content-type');
109 | if (
110 | response.status === 404 ||
111 | (contentType != null && contentType.indexOf('javascript') === -1)
112 | ) {
113 | // No service worker found. Probably a different app. Reload the page.
114 | navigator.serviceWorker.ready.then(registration => {
115 | registration.unregister().then(() => {
116 | window.location.reload();
117 | });
118 | });
119 | } else {
120 | // Service worker found. Proceed as normal.
121 | registerValidSW(swUrl, config);
122 | }
123 | })
124 | .catch(() => {
125 | console.log(
126 | 'No internet connection found. App is running in offline mode.'
127 | );
128 | });
129 | }
130 |
131 | export function unregister() {
132 | if ('serviceWorker' in navigator) {
133 | navigator.serviceWorker.ready
134 | .then(registration => {
135 | registration.unregister();
136 | })
137 | .catch(error => {
138 | console.error(error.message);
139 | });
140 | }
141 | }
142 |
--------------------------------------------------------------------------------
/docs/writegenJSGuide.md:
--------------------------------------------------------------------------------
1 | # WriteGen JavaScript Style Guide
2 |
3 |
4 | ## Table of Contents
5 | * [Whitespace](#whitespace)
6 | * [Column Limit](#columns)
7 | * [Import Statements](#import)
8 | * [Creating New Lines](#newlines)
9 | * [Commenting](#comments)
10 | * [Example Code](#examples)
11 |
12 |
13 | ## Whitespace
14 | - With the exception of function calls, every opening parentheses must have whitespace before it, and every closing parentheses must have whitespace following [it.](#whitespaceExample1)
15 |
16 | ```
17 | for (int i = 0; i < array.length; i++) {
18 | text += array[i] + ;
19 | }
20 | ```
21 |
22 | - Equal signs should have whitespaces on [either side.](#whitespaceExample2)
23 |
24 | ```
25 | var num = 6;
26 | ```
27 |
28 | - For consistency and readability, four spaces will equal a tab, and we should do our best to utilize spaces instead of tabs.
29 |
30 |
31 |
32 | ## Column Limit
33 | - With the exception of the use of strings, avoid line widths longer than 100 characters.
34 | - When using code as object attributes, function parameters, styling attributes, etc. that exceeds the character limit, make sure that each attribute is aligned and separate onto a [new line](#split).
35 |
36 | ```
37 | function someExtremelyLongFunctionName (
38 | writingGeneratorName, articleTitle, articlePictureCaption) {
39 | // example for splitting up parameters onto a new line
40 | }
41 | ```
42 |
43 |
44 | ## Import Statements
45 | - Place all import statements above all non-import statements in order to avoid [any surprises.](#importsBefore)
46 |
47 | ```
48 | // bad example
49 | import Question from "./question"
50 |
51 | function App () {
52 |
53 | }
54 |
55 | import Answer from "./answer"
56 |
57 | // good example
58 | import Header from "./header"
59 | import Content from "./content"
60 | import Footer from "./footer"
61 |
62 | function AppTwo () {
63 |
64 |
65 |
66 | }
67 | ```
68 |
69 | - Do not write ```import``` and ```export``` statements on the [same line.](#importExport)
70 |
71 | ```
72 | // bad
73 | export { spongebob as default } from './WriteGen';
74 |
75 | // good
76 | import { spongebob } from './WriteGen';
77 | export default spongebob;
78 | ```
79 |
80 | - When having multiple imports from one source that exceed the column limit, split the import into [multiple lines.](#importstatement)
81 |
82 | ```
83 | import {
84 | componentA,
85 | componentB,
86 | componentC,
87 | componentD
88 | } from ""./components";
89 | ```
90 |
91 |
92 | ## Creating New Lines
93 | - Utilize new lines to separate [function calls.](#newLine1)
94 |
95 | ```
96 |
97 | function Article (props) {
98 | return (
)
108 | }
109 | ```
110 |
111 | - Object attributes should be in their [own lines](#objLine).
112 |
113 | ```
114 |
116 | ```
117 |
118 | - Avoid utilizing multiple blank lines consecutively.
119 | - Each Javascript component or function call should be on its [own line.](#ownLine)
120 |
121 | ```
122 | // bad example
123 | return (
Jokes!
Puns!
)
124 |
125 | // good example
126 | return (
127 |
Jokes!
128 |
Puns!
129 |
)
130 |
131 | ```
132 |
133 | - With the exception of inline styles, each styling selector should be on its own [independent line.](#styleLine)
134 |
135 | ```
136 | // bad example
137 | const hSty = {
138 | textAlign: "center", fontSize: 20
139 | }
140 |
141 | // good example
142 | const hSty = {
143 | textAlign: "center",
144 | fontSize: 20
145 | }
146 | ```
147 |
148 |
149 | ## Commenting
150 | - Utilize whitespace right after comments (```//``` or ```/**```) in order to increase readability.
151 | - When needed, use small tags as ```TODO:``` or ```FIXME:``` as notes for other developers.
152 | - Use comments as needed to explain complicated concepts, solutions that are not obvious, and overall architecture of the program.
153 |
154 |
155 | ## Additional Example Functions
156 |
157 | ```
158 | if (props.ID == "1") {
159 |