Skip to content

Commit f3b088d

Browse files
jkettmannjkettmann
committed
Update README
1 parent a6d96cb commit f3b088d

File tree

5 files changed

+262
-17
lines changed

5 files changed

+262
-17
lines changed

‎LICENSE.md

Lines changed: 228 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,228 @@
1+
“Commons Clause” License Condition v1.0
2+
3+
The Software is provided to you by the Licensor under the
4+
License, as defined below, subject to the following condition.
5+
6+
Without limiting other conditions in the License, the grant
7+
of rights under the License will not include, and the License
8+
does not grant to you, the right to Sell the Software.
9+
10+
For purposes of the foregoing, “Sell” means practicing any or
11+
all of the rights granted to you under the License to provide
12+
to third parties, for a fee or other consideration (including
13+
without limitation fees for hosting or consulting/ support
14+
services related to the Software), a product or service whose
15+
value derives, entirely or substantially, from the functionality
16+
of the Software. Any license notice or attribution required by
17+
the License must also include this Commons Clause License
18+
Condition notice.
19+
20+
Software: Prolog App / React Job Simulator
21+
22+
License: Apache 2.0 with Commons Clause
23+
24+
Licensor: ooloo software UG
25+
26+
---
27+
28+
Apache License
29+
Version 2.0, January 2004
30+
http://www.apache.org/licenses/
31+
32+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
33+
34+
1. Definitions.
35+
36+
"License" shall mean the terms and conditions for use, reproduction,
37+
and distribution as defined by Sections 1 through 9 of this document.
38+
39+
"Licensor" shall mean the copyright owner or entity authorized by
40+
the copyright owner that is granting the License.
41+
42+
"Legal Entity" shall mean the union of the acting entity and all
43+
other entities that control, are controlled by, or are under common
44+
control with that entity. For the purposes of this definition,
45+
"control" means (i) the power, direct or indirect, to cause the
46+
direction or management of such entity, whether by contract or
47+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
48+
outstanding shares, or (iii) beneficial ownership of such entity.
49+
50+
"You" (or "Your") shall mean an individual or Legal Entity
51+
exercising permissions granted by this License.
52+
53+
"Source" form shall mean the preferred form for making modifications,
54+
including but not limited to software source code, documentation
55+
source, and configuration files.
56+
57+
"Object" form shall mean any form resulting from mechanical
58+
transformation or translation of a Source form, including but
59+
not limited to compiled object code, generated documentation,
60+
and conversions to other media types.
61+
62+
"Work" shall mean the work of authorship, whether in Source or
63+
Object form, made available under the License, as indicated by a
64+
copyright notice that is included in or attached to the work
65+
(an example is provided in the Appendix below).
66+
67+
"Derivative Works" shall mean any work, whether in Source or Object
68+
form, that is based on (or derived from) the Work and for which the
69+
editorial revisions, annotations, elaborations, or other modifications
70+
represent, as a whole, an original work of authorship. For the purposes
71+
of this License, Derivative Works shall not include works that remain
72+
separable from, or merely link (or bind by name) to the interfaces of,
73+
the Work and Derivative Works thereof.
74+
75+
"Contribution" shall mean any work of authorship, including
76+
the original version of the Work and any modifications or additions
77+
to that Work or Derivative Works thereof, that is intentionally
78+
submitted to Licensor for inclusion in the Work by the copyright owner
79+
or by an individual or Legal Entity authorized to submit on behalf of
80+
the copyright owner. For the purposes of this definition, "submitted"
81+
means any form of electronic, verbal, or written communication sent
82+
to the Licensor or its representatives, including but not limited to
83+
communication on electronic mailing lists, source code control systems,
84+
and issue tracking systems that are managed by, or on behalf of, the
85+
Licensor for the purpose of discussing and improving the Work, but
86+
excluding communication that is conspicuously marked or otherwise
87+
designated in writing by the copyright owner as "Not a Contribution."
88+
89+
"Contributor" shall mean Licensor and any individual or Legal Entity
90+
on behalf of whom a Contribution has been received by Licensor and
91+
subsequently incorporated within the Work.
92+
93+
2. Grant of Copyright License. Subject to the terms and conditions of
94+
this License, each Contributor hereby grants to You a perpetual,
95+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
96+
copyright license to reproduce, prepare Derivative Works of,
97+
publicly display, publicly perform, sublicense, and distribute the
98+
Work and such Derivative Works in Source or Object form.
99+
100+
3. Grant of Patent License. Subject to the terms and conditions of
101+
this License, each Contributor hereby grants to You a perpetual,
102+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
103+
(except as stated in this section) patent license to make, have made,
104+
use, offer to sell, sell, import, and otherwise transfer the Work,
105+
where such license applies only to those patent claims licensable
106+
by such Contributor that are necessarily infringed by their
107+
Contribution(s) alone or by combination of their Contribution(s)
108+
with the Work to which such Contribution(s) was submitted. If You
109+
institute patent litigation against any entity (including a
110+
cross-claim or counterclaim in a lawsuit) alleging that the Work
111+
or a Contribution incorporated within the Work constitutes direct
112+
or contributory patent infringement, then any patent licenses
113+
granted to You under this License for that Work shall terminate
114+
as of the date such litigation is filed.
115+
116+
4. Redistribution. You may reproduce and distribute copies of the
117+
Work or Derivative Works thereof in any medium, with or without
118+
modifications, and in Source or Object form, provided that You
119+
meet the following conditions:
120+
121+
(a) You must give any other recipients of the Work or
122+
Derivative Works a copy of this License; and
123+
124+
(b) You must cause any modified files to carry prominent notices
125+
stating that You changed the files; and
126+
127+
(c) You must retain, in the Source form of any Derivative Works
128+
that You distribute, all copyright, patent, trademark, and
129+
attribution notices from the Source form of the Work,
130+
excluding those notices that do not pertain to any part of
131+
the Derivative Works; and
132+
133+
(d) If the Work includes a "NOTICE" text file as part of its
134+
distribution, then any Derivative Works that You distribute must
135+
include a readable copy of the attribution notices contained
136+
within such NOTICE file, excluding those notices that do not
137+
pertain to any part of the Derivative Works, in at least one
138+
of the following places: within a NOTICE text file distributed
139+
as part of the Derivative Works; within the Source form or
140+
documentation, if provided along with the Derivative Works; or,
141+
within a display generated by the Derivative Works, if and
142+
wherever such third-party notices normally appear. The contents
143+
of the NOTICE file are for informational purposes only and
144+
do not modify the License. You may add Your own attribution
145+
notices within Derivative Works that You distribute, alongside
146+
or as an addendum to the NOTICE text from the Work, provided
147+
that such additional attribution notices cannot be construed
148+
as modifying the License.
149+
150+
You may add Your own copyright statement to Your modifications and
151+
may provide additional or different license terms and conditions
152+
for use, reproduction, or distribution of Your modifications, or
153+
for any such Derivative Works as a whole, provided Your use,
154+
reproduction, and distribution of the Work otherwise complies with
155+
the conditions stated in this License.
156+
157+
5. Submission of Contributions. Unless You explicitly state otherwise,
158+
any Contribution intentionally submitted for inclusion in the Work
159+
by You to the Licensor shall be under the terms and conditions of
160+
this License, without any additional terms or conditions.
161+
Notwithstanding the above, nothing herein shall supersede or modify
162+
the terms of any separate license agreement you may have executed
163+
with Licensor regarding such Contributions.
164+
165+
6. Trademarks. This License does not grant permission to use the trade
166+
names, trademarks, service marks, or product names of the Licensor,
167+
except as required for reasonable and customary use in describing the
168+
origin of the Work and reproducing the content of the NOTICE file.
169+
170+
7. Disclaimer of Warranty. Unless required by applicable law or
171+
agreed to in writing, Licensor provides the Work (and each
172+
Contributor provides its Contributions) on an "AS IS" BASIS,
173+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
174+
implied, including, without limitation, any warranties or conditions
175+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
176+
PARTICULAR PURPOSE. You are solely responsible for determining the
177+
appropriateness of using or redistributing the Work and assume any
178+
risks associated with Your exercise of permissions under this License.
179+
180+
8. Limitation of Liability. In no event and under no legal theory,
181+
whether in tort (including negligence), contract, or otherwise,
182+
unless required by applicable law (such as deliberate and grossly
183+
negligent acts) or agreed to in writing, shall any Contributor be
184+
liable to You for damages, including any direct, indirect, special,
185+
incidental, or consequential damages of any character arising as a
186+
result of this License or out of the use or inability to use the
187+
Work (including but not limited to damages for loss of goodwill,
188+
work stoppage, computer failure or malfunction, or any and all
189+
other commercial damages or losses), even if such Contributor
190+
has been advised of the possibility of such damages.
191+
192+
9. Accepting Warranty or Additional Liability. While redistributing
193+
the Work or Derivative Works thereof, You may choose to offer,
194+
and charge a fee for, acceptance of support, warranty, indemnity,
195+
or other liability obligations and/or rights consistent with this
196+
License. However, in accepting such obligations, You may act only
197+
on Your own behalf and on Your sole responsibility, not on behalf
198+
of any other Contributor, and only if You agree to indemnify,
199+
defend, and hold each Contributor harmless for any liability
200+
incurred by, or claims asserted against, such Contributor by reason
201+
of your accepting any such warranty or additional liability.
202+
203+
END OF TERMS AND CONDITIONS
204+
205+
APPENDIX: How to apply the Apache License to your work.
206+
207+
To apply the Apache License to your work, attach the following
208+
boilerplate notice, with the fields enclosed by brackets "[]"
209+
replaced with your own identifying information. (Don't include
210+
the brackets!) The text should be enclosed in the appropriate
211+
comment syntax for the file format. We also recommend that a
212+
file or class name and description of purpose be included on the
213+
same "printed page" as the copyright notice for easier
214+
identification within third-party archives.
215+
216+
Copyright 2022 ooloo software UG
217+
218+
Licensed under the Apache License, Version 2.0 (the "License");
219+
you may not use this file except in compliance with the License.
220+
You may obtain a copy of the License at
221+
222+
http://www.apache.org/licenses/LICENSE-2.0
223+
224+
Unless required by applicable law or agreed to in writing, software
225+
distributed under the License is distributed on an "AS IS" BASIS,
226+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
227+
See the License for the specific language governing permissions and
228+
limitations under the License.

‎README.md

Lines changed: 34 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,51 @@
1-
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
1+
This repository is part of the [React Job Simulator](https://profy.dev) where you work in a professional dev environment with advanced tooling and workflows. You implement tasks based on designs starting from small bug fixes to full-blown features. Basically, you learn a lot of the things hands-on that you usually only experience once you joined a professional React team.
2+
3+
## The Application
4+
5+
The application is an error logging and monitoring tool similar to Sentry or Rollbar. You can find a deployed version of the main branch at [prolog.profy.dev](https://prolog.profy.dev).
6+
7+
![The running application](docs/app.png)
8+
9+
## Codebase Tour
10+
11+
Watch this video for a tour through the codebase.
12+
13+
[![Codebase tour](docs/codebase-tour.jpg)](https://www.youtube.com/watch?v=a_Z0yUsChlY)
214

315
## Getting Started
416

5-
First, run the development server:
17+
This project is built with Next.js, TypeScript, Cypress & styled-components among others. To start working on the project, first clone the repository and install the dependencies.
618

719
```bash
8-
npm run dev
9-
# or
10-
yarn dev
20+
npm install
1121
```
1222

13-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
23+
Then run the development server:
1424

15-
You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
25+
```bash
26+
npm run dev
27+
```
1628

17-
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
29+
Now you can open [http://localhost:3000](http://localhost:3000) with your browser to see the application.
1830

19-
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
31+
## Tests
2032

21-
## Learn More
33+
This project is covered with Cypress tests. Although most tests for production apps are currently written with React Testing Library, Cypress is the best option to get started with testing. When you're new to testing the start can be very cumbersome and feel like you're in a completely new dev environment.
2234

23-
To learn more about Next.js, take a look at the following resources:
35+
Cypress makes it much easier to get started with testing. You still have to get used to the new way of coding but thanks to its awesome UI debugging is easy and very similar to what you're used from your browser.
2436

25-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
26-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
37+
![Cypress test](docs/cypress.gif)
2738

28-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
39+
To run the Cypress tests on your local machine use this command:
2940

30-
## Deploy on Vercel
41+
```bash
42+
npm run cypress
43+
```
3144

32-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
45+
## Storybook
3346

34-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
47+
Storybook is a great tool to document your components and visually test them in isolation. To open Storybook run
48+
49+
```bash
50+
npm run storybook
51+
```

‎docs/app.png

210 KB
Loading

‎docs/codebase-tour.jpg

522 KB
Loading

‎docs/cypress.gif

4.65 MB
Loading

0 commit comments

Comments
 (0)