First commit
This commit is contained in:
17
.babelrc
Executable file
17
.babelrc
Executable file
@@ -0,0 +1,17 @@
|
|||||||
|
{
|
||||||
|
"presets": [
|
||||||
|
[
|
||||||
|
"env",
|
||||||
|
{
|
||||||
|
"targets": {
|
||||||
|
"browsers": ["last 2 versions", "ie 11"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"babel-preset-react"
|
||||||
|
],
|
||||||
|
"plugins": [
|
||||||
|
"transform-object-rest-spread",
|
||||||
|
"transform-class-properties"
|
||||||
|
]
|
||||||
|
}
|
||||||
10
.dockerignore
Executable file
10
.dockerignore
Executable file
@@ -0,0 +1,10 @@
|
|||||||
|
node_modules
|
||||||
|
npm-debug.log
|
||||||
|
README.md
|
||||||
|
LICENSE
|
||||||
|
.babelrc
|
||||||
|
.eslintignore
|
||||||
|
.eslintrc.json
|
||||||
|
.gitignore
|
||||||
|
.npmignore
|
||||||
|
commitlint.config.js
|
||||||
3
.eslintignore
Executable file
3
.eslintignore
Executable file
@@ -0,0 +1,3 @@
|
|||||||
|
coverage/*
|
||||||
|
dist/
|
||||||
|
node_modules/
|
||||||
24
.eslintrc
Executable file
24
.eslintrc
Executable file
@@ -0,0 +1,24 @@
|
|||||||
|
{
|
||||||
|
"extends": "eslint-config-edx",
|
||||||
|
"parser": "babel-eslint",
|
||||||
|
"rules": {
|
||||||
|
"import/no-extraneous-dependencies": [
|
||||||
|
"error",
|
||||||
|
{
|
||||||
|
"devDependencies": [
|
||||||
|
"config/*.js",
|
||||||
|
"**/*.test.jsx",
|
||||||
|
"**/*.test.js"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
// https://github.com/evcohen/eslint-plugin-jsx-a11y/issues/340#issuecomment-338424908
|
||||||
|
"jsx-a11y/anchor-is-valid": [ "error", {
|
||||||
|
"components": [ "Link" ],
|
||||||
|
"specialLink": [ "to" ]
|
||||||
|
}]
|
||||||
|
},
|
||||||
|
"env": {
|
||||||
|
"jest": true
|
||||||
|
}
|
||||||
|
}
|
||||||
7
.gitignore
vendored
Executable file
7
.gitignore
vendored
Executable file
@@ -0,0 +1,7 @@
|
|||||||
|
.DS_Store
|
||||||
|
.eslintcache
|
||||||
|
node_modules
|
||||||
|
npm-debug.log
|
||||||
|
coverage
|
||||||
|
|
||||||
|
dist/
|
||||||
13
.npmignore
Executable file
13
.npmignore
Executable file
@@ -0,0 +1,13 @@
|
|||||||
|
.eslintignore
|
||||||
|
.eslintrc.json
|
||||||
|
.gitignore
|
||||||
|
.travis.yml
|
||||||
|
docker-compose.yml
|
||||||
|
Dockerfile
|
||||||
|
Makefile
|
||||||
|
npm-debug.log
|
||||||
|
|
||||||
|
config
|
||||||
|
coverage
|
||||||
|
node_modules
|
||||||
|
public
|
||||||
42
.travis.yml
Executable file
42
.travis.yml
Executable file
@@ -0,0 +1,42 @@
|
|||||||
|
language: node_js
|
||||||
|
node_js:
|
||||||
|
- "lts/*"
|
||||||
|
cache:
|
||||||
|
directories:
|
||||||
|
- "~/.npm"
|
||||||
|
notifications:
|
||||||
|
email:
|
||||||
|
recipients:
|
||||||
|
- jbradley@edx.org
|
||||||
|
on_success: never
|
||||||
|
on_failure: always
|
||||||
|
hipchat:
|
||||||
|
rooms:
|
||||||
|
secure: g5fu70/Dv5qaE7UztS2FWEwhTpEOwDo9CMA/J6jcdKrpT/vRqAkAD5x3WHrHdN2BMOJh2VeFO7xAeAuTwf072kc6Q+ND8Zi495Wc1FItKApzYiipYPBouYdgRbP0oqplII1TaGAbs7YB/7xPApkhNwG+KV2p+ih8aaRUPRqmEYgTkiXWGsrgs4E0L070TPR75Fc9GsxaTnCcZ4tCSdvlOmlMJaF9jNiF6+6zkANWsrHW70zU+7YA8muT7NLFKB1l0tcJOpxr3svWFl4SFdoiqVm2SPO6VjJE6HaxPt82lin0Hvovm5ABxc5Y953SC/9c8TteT5XNAO9PrcO7AKIivjkR2XYGkTIk0DUTex5rVPXvN4AxjA3kXGmg947fAI8MmlTXD/BgkryVfOyuh2jO7RKvnjtosVshmGjsDO8VC1cZCQQLMYrMBQHcfiBcHU0hYKCtSgH5NsIA8S4WQk0w50uR9QiZgAHEuQME1tiFQt8DozQX5nH5Im+jZgrbt/2Nzy2l7eG1QExx+X8bHhRezZuRbQOgFCnbCnr5iUtE9sQJVhdsyyo8cTS36HsYOL8868HKgWdY8UPtwoe3ZfKUo8hlORAr2B3XUv9vBz0W9GwvrNcYrJrpt+xVIqKwCdx/dxDscCAgrN7JGlw2rQQU+bqOpTp4v8Ut+fDUCZZWEUM=
|
||||||
|
webhooks: https://www.travisbuddy.com/
|
||||||
|
on_success: never
|
||||||
|
before_install:
|
||||||
|
- npm install -g npm@latest
|
||||||
|
- npm install -g greenkeeper-lockfile@1.14.0
|
||||||
|
install:
|
||||||
|
- npm ci
|
||||||
|
before_script: greenkeeper-lockfile-update
|
||||||
|
after_script: greenkeeper-lockfile-upload
|
||||||
|
script:
|
||||||
|
- make validate-no-uncommitted-package-lock-changes
|
||||||
|
- npm run lint
|
||||||
|
- npm run test
|
||||||
|
- npm run build
|
||||||
|
- npm run is-es5
|
||||||
|
after_success:
|
||||||
|
- npm run build:gh-pages
|
||||||
|
deploy:
|
||||||
|
local-dir: "./dist"
|
||||||
|
provider: pages
|
||||||
|
skip-cleanup: true
|
||||||
|
github-token: "$GITHUB_TOKEN"
|
||||||
|
keep-history: true
|
||||||
|
name: edx-semantic-release
|
||||||
|
email: edx-semantic-release@edx.org
|
||||||
|
on:
|
||||||
|
branch: master
|
||||||
29
Dockerfile
Executable file
29
Dockerfile
Executable file
@@ -0,0 +1,29 @@
|
|||||||
|
# Copied from https://github.com/BretFisher/node-docker-good-defaults/blob/master/Dockerfile
|
||||||
|
|
||||||
|
FROM node:8.9.3
|
||||||
|
|
||||||
|
# Create app directory
|
||||||
|
RUN mkdir -p /edx/app
|
||||||
|
|
||||||
|
ARG NODE_ENV=production
|
||||||
|
ENV NODE_ENV $NODE_ENV
|
||||||
|
|
||||||
|
ARG PORT=80
|
||||||
|
ENV PORT $PORT
|
||||||
|
EXPOSE $PORT 1991
|
||||||
|
|
||||||
|
WORKDIR /edx
|
||||||
|
# Install app dependencies
|
||||||
|
# A wildcard is used to ensure both package.json AND package-lock.json are copied
|
||||||
|
# where available (npm@5+)
|
||||||
|
COPY package*.json ./
|
||||||
|
|
||||||
|
# If you are building your code for production
|
||||||
|
# RUN npm install --only=production
|
||||||
|
RUN npm install
|
||||||
|
ENV PATH /edx/app/node_modules/.bin:$PATH
|
||||||
|
|
||||||
|
WORKDIR /edx/app
|
||||||
|
COPY . /edx/app
|
||||||
|
|
||||||
|
ENTRYPOINT npm install && npm run start
|
||||||
674
LICENSE
Executable file
674
LICENSE
Executable file
@@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||||
32
Makefile
Executable file
32
Makefile
Executable file
@@ -0,0 +1,32 @@
|
|||||||
|
shell: ## run a shell on the cookie-cutter container
|
||||||
|
docker exec -it edx.fecc /bin/bash
|
||||||
|
|
||||||
|
build:
|
||||||
|
docker-compose build
|
||||||
|
|
||||||
|
up: ## bring up cookie-cutter container
|
||||||
|
docker-compose up
|
||||||
|
|
||||||
|
up-detached: ## bring up cookie-cutter container in detached mode
|
||||||
|
docker-compose up -d
|
||||||
|
|
||||||
|
logs: ## show logs for cookie-cutter container
|
||||||
|
docker-compose logs -f
|
||||||
|
|
||||||
|
down: ## stop and remove cookie-cutter container
|
||||||
|
docker-compose down
|
||||||
|
|
||||||
|
npm-install-%: ## install specified % npm package on the cookie-cutter container
|
||||||
|
docker exec npm install $* --save-dev
|
||||||
|
git add package.json
|
||||||
|
|
||||||
|
restart:
|
||||||
|
make down
|
||||||
|
make up
|
||||||
|
|
||||||
|
restart-detached:
|
||||||
|
make down
|
||||||
|
make up-detached
|
||||||
|
|
||||||
|
validate-no-uncommitted-package-lock-changes:
|
||||||
|
git diff --exit-code package-lock.json
|
||||||
106
README.md
Executable file
106
README.md
Executable file
@@ -0,0 +1,106 @@
|
|||||||
|
[](https://greenkeeper.io/)
|
||||||
|
|
||||||
|
# 🍪 front-end-cookie-cutter 🍪
|
||||||
|
|
||||||
|
Please tag **@edx/fedx-team** on any PRs or issues.
|
||||||
|
|
||||||
|
## Introduction
|
||||||
|
|
||||||
|
The purpose of this repository is to illustrate general front-end best practices for [`React`](https://reactjs.org/) and [`Redux`](https://redux.js.org) applications using a handful of (overly) simplified examples.
|
||||||
|
|
||||||
|
We are currently using `node v8.9.3` and `npm@5.5.1`.
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
After cloning the repository, run `make up-detached` in the `front-end-cookie-cutter` directory - this will build and start the `front-end-cookie-cutter` web application in a docker container.
|
||||||
|
|
||||||
|
Hopefully, the output looks something like
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
The web application runs on port **1991**, so when you go to `http://localhost:1991` you should see something like
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
If you don't, you can see the log messages for the docker container by executing `make logs` in the `front-end-cookie-cutter` directory. This should output something like
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Note that `make up-detached` executes the `npm run start` script which will hot-reload JavaScript and Sass files changes, so you should (:crossed_fingers:) not need to do anything (other than wait) when making changes.
|
||||||
|
|
||||||
|
## Directory Structure
|
||||||
|
|
||||||
|
* `config`
|
||||||
|
* Directory for [`webpack`](https://webpack.js.org/) configurations
|
||||||
|
* `public`
|
||||||
|
* Entry point for the single-page application - `front-end-cookie-cutter` has a single `index.html` file
|
||||||
|
* `src`
|
||||||
|
* `components`
|
||||||
|
* Directory for presentational `React` components
|
||||||
|
* `containers`
|
||||||
|
* Directory for container `React` components
|
||||||
|
* `data`
|
||||||
|
* `actions`
|
||||||
|
* Directory for `Redux` action creators
|
||||||
|
* `constants`
|
||||||
|
* `reducers`
|
||||||
|
* Directory for `Redux` reducers
|
||||||
|
* [`.babelrc`](#babelrc)
|
||||||
|
* [`.dockerignore`](#dockerignore)
|
||||||
|
* [`.eslintignore`](#eslintignore)
|
||||||
|
* [`.eslintrc.js`](#eslintrcjs)
|
||||||
|
* `.gitignore`
|
||||||
|
* [`npmignore`](#npmignore)
|
||||||
|
* [`.travis.yml`](#travisyml)
|
||||||
|
* `docker-compose.yml`
|
||||||
|
* `Dockerfile`
|
||||||
|
* `LICENSE`
|
||||||
|
* `Makefile`
|
||||||
|
* `package-lock.json`
|
||||||
|
* [`package.json`](#packagejson)
|
||||||
|
|
||||||
|
### `.babelrc`
|
||||||
|
|
||||||
|
We use [`Babel`](https://babeljs.io/) to transpile `ES2015+` JavaScript to `ES5` JavaScript. `ES5` JavaScript has [greater browser compatibility](http://kangax.github.io/compat-table/es5/) than [`ES2015+`](http://kangax.github.io/compat-table/es6/).
|
||||||
|
|
||||||
|
The `.babelrc` file is used to specify a particular configuration - for example, we use the [`babel-preset-react`](https://babeljs.io/docs/plugins/preset-react/), which, among other things, allows `babel` to parse `JSX`.
|
||||||
|
|
||||||
|
### `.dockerignore`
|
||||||
|
|
||||||
|
The important thing to remember is to add the `node_modules` directory to `.dockerignore` - for more information [see the Docker documentation](https://docs.docker.com/engine/reference/builder/#dockerignore-file).
|
||||||
|
|
||||||
|
### `.eslintignore`
|
||||||
|
|
||||||
|
We use [`eslint`](https://eslint.org/) for our `JavaScript` linting needs. The `.eslintignore` file is used to [specify files or directories to, well, ignore](https://eslint.org/docs/user-guide/configuring#ignoring-files-and-directories).
|
||||||
|
|
||||||
|
While `eslint` automatically ignores `node_modules`, we like to add it to the `.eslintignore` just for the added explicitness. In addition, you probably want to add the directory for your compiled files (in our case, `./dist`) and your coverage directory (in our case, `./coverage`).
|
||||||
|
|
||||||
|
### `.eslintrc`
|
||||||
|
|
||||||
|
This is where the actual `eslint` configuration is specified. All `edX` JavaScript projects should extend either the [`eslint-config-edx`](https://github.com/edx/eslint-config-edx/blob/master/packages/eslint-config-edx/README.md) or [`eslint-config-edx-es5`](https://github.com/edx/eslint-config-edx/blob/master/packages/eslint-config-edx-es5/README.md) configurations (for `ES2015+` and `ES5` JavaScript, respectively). Both configurations can be found in [the `eslint-config-edx` repository](https://github.com/edx/eslint-config-edx).
|
||||||
|
|
||||||
|
### `.npmignore`
|
||||||
|
|
||||||
|
We are not currently publishing this package to [`npm`](https://www.npmjs.com/). If we did, we would want to exclude certain files from getting uploaded to `npm` (like our coverage files, for example). For more information, see [the `npm` documentation](https://docs.npmjs.com/misc/developers#keeping-files-out-of-your-package).
|
||||||
|
|
||||||
|
### `.travis.yml`
|
||||||
|
|
||||||
|
We use [`Travis CI`](https://travis-ci.org/) to build (and deploy) our application. The `.travis.yml` file specifies the configuration for `Travis` builds. For more information, see [the `Travis` documentation](https://docs.travis-ci.com/user/customizing-the-build/).
|
||||||
|
|
||||||
|
### `package.json`
|
||||||
|
|
||||||
|
Arguably, one of the **most important files in an `npm`-based application**, the `package.json` file specifies everything from the `name` of the application, were it to be published to `npm`, to it's `dependencies`.
|
||||||
|
|
||||||
|
For more information, see [the `npm` documentation](https://docs.npmjs.com/files/package.json).
|
||||||
|
|
||||||
|
## Helpful Applications
|
||||||
|
|
||||||
|
### [`Greenkeeper`](https://greenkeeper.io/)
|
||||||
|
|
||||||
|
[`Greenkeeper`](https://greenkeeper.io/) is basically a `GitHub` application that handles `npm` dependencies. It will automatically open PRs with `package.json` updates when new versions of your `npm` dependencies get published. There are ways to also automatically keep the `package-lock.json` in-line, in the same PR, using [`greenkeeper-lockfile`].
|
||||||
|
|
||||||
|
For more information, see [the `Greenkeeper` documentation](https://greenkeeper.io/docs.html#what-greenkeeper-does).
|
||||||
|
|
||||||
|
## Authentication with backend API services
|
||||||
|
|
||||||
|
See the [`@edx/frontend-auth`](https://github.com/edx/frontend-auth) repo for information about securing routes in your application that require user authentication.
|
||||||
15
config/webpack.common.config.js
Executable file
15
config/webpack.common.config.js
Executable file
@@ -0,0 +1,15 @@
|
|||||||
|
// This is the common Webpack config. The dev and prod Webpack configs both
|
||||||
|
// inherit config defined here.
|
||||||
|
const path = require('path');
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
entry: {
|
||||||
|
app: path.resolve(__dirname, '../src/index.jsx'),
|
||||||
|
},
|
||||||
|
output: {
|
||||||
|
path: path.resolve(__dirname, '../dist'),
|
||||||
|
},
|
||||||
|
resolve: {
|
||||||
|
extensions: ['.js', '.jsx'],
|
||||||
|
},
|
||||||
|
};
|
||||||
90
config/webpack.dev.config.js
Executable file
90
config/webpack.dev.config.js
Executable file
@@ -0,0 +1,90 @@
|
|||||||
|
// This is the dev Webpack config. All settings here should prefer a fast build
|
||||||
|
// time at the expense of creating larger, unoptimized bundles.
|
||||||
|
const Merge = require('webpack-merge');
|
||||||
|
const path = require('path');
|
||||||
|
const HtmlWebpackPlugin = require('html-webpack-plugin');
|
||||||
|
const webpack = require('webpack');
|
||||||
|
|
||||||
|
const commonConfig = require('./webpack.common.config.js');
|
||||||
|
|
||||||
|
module.exports = Merge.smart(commonConfig, {
|
||||||
|
mode: 'development',
|
||||||
|
entry: [
|
||||||
|
// enable react's custom hot dev client so we get errors reported in the browser
|
||||||
|
require.resolve('react-dev-utils/webpackHotDevClient'),
|
||||||
|
path.resolve(__dirname, '../src/index.jsx'),
|
||||||
|
],
|
||||||
|
module: {
|
||||||
|
// Specify file-by-file rules to Webpack. Some file-types need a particular kind of loader.
|
||||||
|
rules: [
|
||||||
|
// The babel-loader transforms newer ES2015+ syntax to older ES5 for older browsers.
|
||||||
|
// Babel is configured with the .babelrc file at the root of the project.
|
||||||
|
{
|
||||||
|
test: /\.(js|jsx)$/,
|
||||||
|
include: [
|
||||||
|
path.resolve(__dirname, '../src'),
|
||||||
|
],
|
||||||
|
loader: 'babel-loader',
|
||||||
|
options: {
|
||||||
|
// Caches result of loader to the filesystem. Future builds will attempt to read from the
|
||||||
|
// cache to avoid needing to run the expensive recompilation process on each run.
|
||||||
|
cacheDirectory: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
// We are not extracting CSS from the javascript bundles in development because extracting
|
||||||
|
// prevents hot-reloading from working, it increases build time, and we don't care about
|
||||||
|
// flash-of-unstyled-content issues in development.
|
||||||
|
{
|
||||||
|
test: /(.scss|.css)$/,
|
||||||
|
use: [
|
||||||
|
'style-loader', // creates style nodes from JS strings
|
||||||
|
{
|
||||||
|
loader: 'css-loader', // translates CSS into CommonJS
|
||||||
|
options: {
|
||||||
|
sourceMap: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
loader: 'sass-loader', // compiles Sass to CSS
|
||||||
|
options: {
|
||||||
|
sourceMap: true,
|
||||||
|
includePaths: [
|
||||||
|
path.join(__dirname, '../node_modules'),
|
||||||
|
path.join(__dirname, '../src'),
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
// Webpack, by default, uses the url-loader for images and fonts that are required/included by
|
||||||
|
// files it processes, which just base64 encodes them and inlines them in the javascript
|
||||||
|
// bundles. This makes the javascript bundles ginormous and defeats caching so we will use the
|
||||||
|
// file-loader instead to copy the files directly to the output directory.
|
||||||
|
{
|
||||||
|
test: /\.(woff2?|ttf|svg|eot)(\?v=\d+\.\d+\.\d+)?$/,
|
||||||
|
loader: 'file-loader',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
// Specify additional processing or side-effects done on the Webpack output bundles as a whole.
|
||||||
|
plugins: [
|
||||||
|
// Generates an HTML file in the output directory.
|
||||||
|
new HtmlWebpackPlugin({
|
||||||
|
inject: true, // Appends script tags linking to the webpack bundles at the end of the body
|
||||||
|
template: path.resolve(__dirname, '../public/index.html'),
|
||||||
|
}),
|
||||||
|
// when the --hot option is not passed in as part of the command
|
||||||
|
// the HotModuleReplacementPlugin has to be specified in the Webpack configuration
|
||||||
|
// https://webpack.js.org/configuration/dev-server/#devserver-hot
|
||||||
|
new webpack.HotModuleReplacementPlugin(),
|
||||||
|
],
|
||||||
|
// This configures webpack-dev-server which serves bundles from memory and provides live
|
||||||
|
// reloading.
|
||||||
|
devServer: {
|
||||||
|
host: '0.0.0.0',
|
||||||
|
port: 1991,
|
||||||
|
historyApiFallback: true,
|
||||||
|
hot: true,
|
||||||
|
inline: true,
|
||||||
|
},
|
||||||
|
});
|
||||||
95
config/webpack.prod.config.js
Executable file
95
config/webpack.prod.config.js
Executable file
@@ -0,0 +1,95 @@
|
|||||||
|
// This is the prod Webpack config. All settings here should prefer smaller,
|
||||||
|
// optimized bundles at the expense of a longer build time.
|
||||||
|
const Merge = require('webpack-merge');
|
||||||
|
const commonConfig = require('./webpack.common.config.js');
|
||||||
|
const path = require('path');
|
||||||
|
const ExtractTextPlugin = require('extract-text-webpack-plugin');
|
||||||
|
const HtmlWebpackPlugin = require('html-webpack-plugin');
|
||||||
|
|
||||||
|
module.exports = Merge.smart(commonConfig, {
|
||||||
|
mode: 'production',
|
||||||
|
devtool: 'source-map',
|
||||||
|
output: {
|
||||||
|
filename: '[name].[chunkhash].js',
|
||||||
|
path: path.resolve(__dirname, '../dist'),
|
||||||
|
},
|
||||||
|
module: {
|
||||||
|
// Specify file-by-file rules to Webpack. Some file-types need a particular kind of loader.
|
||||||
|
rules: [
|
||||||
|
// The babel-loader transforms newer ES2015+ syntax to older ES5 for older browsers.
|
||||||
|
// Babel is configured with the .babelrc file at the root of the project.
|
||||||
|
{
|
||||||
|
test: /\.(js|jsx)$/,
|
||||||
|
include: [
|
||||||
|
path.resolve(__dirname, '../src'),
|
||||||
|
],
|
||||||
|
loader: 'babel-loader',
|
||||||
|
},
|
||||||
|
// Webpack, by default, includes all CSS in the javascript bundles. Unfortunately, that means:
|
||||||
|
// a) The CSS won't be cached by browsers separately (a javascript change will force CSS
|
||||||
|
// re-download). b) Since CSS is applied asyncronously, it causes an ugly
|
||||||
|
// flash-of-unstyled-content.
|
||||||
|
//
|
||||||
|
// To avoid these problems, we extract the CSS from the bundles into separate CSS files that
|
||||||
|
// can be included as <link> tags in the HTML <head> manually.
|
||||||
|
//
|
||||||
|
// We will not do this in development because it prevents hot-reloading from working and it
|
||||||
|
// increases build time.
|
||||||
|
{
|
||||||
|
test: /(.scss|.css)$/,
|
||||||
|
use: ExtractTextPlugin.extract({
|
||||||
|
// creates style nodes from JS strings, only used if extracting fails
|
||||||
|
fallback: 'style-loader',
|
||||||
|
use: [
|
||||||
|
{
|
||||||
|
loader: 'css-loader', // translates CSS into CommonJS
|
||||||
|
options: {
|
||||||
|
sourceMap: true,
|
||||||
|
minimize: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
loader: 'sass-loader', // compiles Sass to CSS
|
||||||
|
options: {
|
||||||
|
sourceMap: true,
|
||||||
|
includePaths: [
|
||||||
|
path.join(__dirname, '../node_modules'),
|
||||||
|
path.join(__dirname, '../src'),
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
// Webpack, by default, uses the url-loader for images and fonts that are required/included by
|
||||||
|
// files it processes, which just base64 encodes them and inlines them in the javascript
|
||||||
|
// bundles. This makes the javascript bundles ginormous and defeats caching so we will use the
|
||||||
|
// file-loader instead to copy the files directly to the output directory.
|
||||||
|
{
|
||||||
|
test: /\.(woff2?|ttf|svg|eot)(\?v=\d+\.\d+\.\d+)?$/,
|
||||||
|
loader: 'file-loader',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
// New in Webpack 4. Replaces CommonChunksPlugin. Extract common modules among all chunks to one
|
||||||
|
// common chunk and extract the Webpack runtime to a single runtime chunk.
|
||||||
|
optimization: {
|
||||||
|
runtimeChunk: 'single',
|
||||||
|
splitChunks: {
|
||||||
|
chunks: 'all',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
// Specify additional processing or side-effects done on the Webpack output bundles as a whole.
|
||||||
|
plugins: [
|
||||||
|
// Writes the extracted CSS from each entry to a file in the output directory.
|
||||||
|
new ExtractTextPlugin({
|
||||||
|
filename: '[name].min.css',
|
||||||
|
allChunks: true,
|
||||||
|
}),
|
||||||
|
// Generates an HTML file in the output directory.
|
||||||
|
new HtmlWebpackPlugin({
|
||||||
|
inject: true, // Appends script tags linking to the webpack bundles at the end of the body
|
||||||
|
template: path.resolve(__dirname, '../public/index.html'),
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
});
|
||||||
20
docker-compose.yml
Executable file
20
docker-compose.yml
Executable file
@@ -0,0 +1,20 @@
|
|||||||
|
version: "2"
|
||||||
|
services:
|
||||||
|
web:
|
||||||
|
build:
|
||||||
|
context: .
|
||||||
|
dockerfile: Dockerfile
|
||||||
|
args:
|
||||||
|
- NODE_ENV=development
|
||||||
|
container_name: edx.fecc
|
||||||
|
image: edxops/front-end-cookie-cutter:latest
|
||||||
|
volumes:
|
||||||
|
- .:/edx/app:delegated
|
||||||
|
- notused:/edx/app/node_modules
|
||||||
|
ports:
|
||||||
|
- "1991:1991"
|
||||||
|
environment:
|
||||||
|
- NODE_ENV=development
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
notused:
|
||||||
77
documentation/.travis.yml.md
Executable file
77
documentation/.travis.yml.md
Executable file
@@ -0,0 +1,77 @@
|
|||||||
|
# Travis Configuration
|
||||||
|
|
||||||
|
Your project might have different build requirements - however, this project's `.travis.yml` configuration is supposed to represent a good starting point.
|
||||||
|
|
||||||
|
## Node JS Version
|
||||||
|
|
||||||
|
The minimum `Node` and `npm` versions that edX supports is `8.9.3` and `5.5.1`, respectively.
|
||||||
|
|
||||||
|
## Caching node_modules
|
||||||
|
|
||||||
|
While [the `Travis` blog](https://blog.travis-ci.com/2016-11-21-travis-ci-now-supports-yarn) recommends
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
cache:
|
||||||
|
directories:
|
||||||
|
- node_modules
|
||||||
|
```
|
||||||
|
|
||||||
|
this causes issues when testing different versions of `Node` because [`node_modules` will store the compiled native modules](https://stackoverflow.com/a/42523517/5225575).
|
||||||
|
|
||||||
|
Caching the `~/.npm` directory avoids storing these native modules.
|
||||||
|
|
||||||
|
## Notifications
|
||||||
|
|
||||||
|
This project uses a service called [`TravisBuddy`](https://www.travisbuddy.com/), which provides Travis build context within a PR via webhooks (configured only to add feedback for build failures).
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Installing `greenkeeper-lockfile`
|
||||||
|
|
||||||
|
As explained in [the `Greenkeeper` documentation](https://greenkeeper.io/docs.html#greenkeeper-step-by-step), `Greenkeeper` is a service that keeps track of your project's dependencies, and will, for example, automatically open PRs with an updated `package.json` file when the latest version of a dependency is a major version ahead of the existing dependency version in your `package.json` file.
|
||||||
|
|
||||||
|
This automated updating is great, but `Greenkeeper` does not update your `package-lock.json` file, just your `package.json` file. This makes sense, as the only way to update the `package-lock.json` file would be to run `npm install` when building your project, using the latest `package.json`, and then committing the updated `package-lock.json` file.
|
||||||
|
|
||||||
|
This is essentially what you have to do manually when `Greenkeeper` opens a PR - `git checkout` the branch, `npm install` locally, `git commit` the `package-lock.json` changes, and then `git push` those changes to the `Greenkeeper` branch on `origin`. It's fun probably only the first time, and even then it gets old, fast.
|
||||||
|
|
||||||
|
What [`greenkeeper-lockfile`](https://github.com/greenkeeperio/greenkeeper-lockfile) does is that it automates the previous steps as part of the build process.
|
||||||
|
|
||||||
|
It will
|
||||||
|
* Check that the branch is a `Greenkeeper` branch
|
||||||
|
* Update the lockfile
|
||||||
|
* Push a commit with the updated lockfile back to the Greenkeeper branch
|
||||||
|
|
||||||
|
This is why it's important to install `greenkeeper-lockfile` in the `before_install` step, and since it's used exclusively only in the Travis Build, why it's not part of the package's dependencies.
|
||||||
|
|
||||||
|
## Scripts
|
||||||
|
|
||||||
|
Most of the `script`s are self-explanatory - you probably want to fail a build if there are linting violations, or if any tests don't pass, or if it cannot compile your files.
|
||||||
|
|
||||||
|
However, there are a couple additional `script`s that might seem less self-explanatory.
|
||||||
|
|
||||||
|
### What the heck is `make validate-no-uncommitted-package-lock-changes`?
|
||||||
|
|
||||||
|
There are only two requirements for a good `make target` name
|
||||||
|
|
||||||
|
1. Definitely make it really verbose so people can't remember what it's called
|
||||||
|
2. Definitely don't not use a double-negative
|
||||||
|
|
||||||
|
What `make validate-no-uncommitted-package-lock-changes` does is `git diff`s for any `package-lock.json` file changes in your project. It's important to remember that all build `script`s are executed in Travis *after* the `install` step (aka post-`npm install`).
|
||||||
|
|
||||||
|
This is important because `npm` uses the pinned dependencies in your `package-lock.json` file to build the `node_modules` directory. However, the dependencies defined within the `package.json` file can be modified manually, for example, to become misaligned with the dependencies defined within the `package-lock.json`. So when `npm install` executes, the `package-lock.json` file will be updated to mirror the modified `package.json` changes.
|
||||||
|
|
||||||
|
However, when these changes surface within a Travis build, this indicates differing dependency expectations between the committed `package.json` file and the `package-lock.json` file, which is a good reason to fail a build.
|
||||||
|
|
||||||
|
### What is this `npm run is-es5` check?
|
||||||
|
|
||||||
|
This project outputs production files to the `dist` folder. The `npm script`, `npm run is-es5`, checks the JavaScript files in the `dist` folder to make sure that they are `ES5`-compliant.
|
||||||
|
|
||||||
|
This check is important because `ES5` JavaScript has [greater browser compatibility](http://kangax.github.io/compat-table/es5/) than [`ES2015+`](http://kangax.github.io/compat-table/es6/) - particularly for `IE11`.
|
||||||
|
|
||||||
|
### `deploy` step
|
||||||
|
|
||||||
|
How your project deploys will probably differ between the cookie cutter and your own application.
|
||||||
|
|
||||||
|
For demonstrational purposes, the cookie cutter deploys to GitHub pages using [`Travis`'s GitHub pages configuration](https://docs.travis-ci.com/user/deployment/pages/).
|
||||||
|
|
||||||
|
Your application might deploy to an `S3` bucket or to `npm`.
|
||||||
16809
package-lock.json
generated
Executable file
16809
package-lock.json
generated
Executable file
File diff suppressed because it is too large
Load Diff
96
package.json
Executable file
96
package.json
Executable file
@@ -0,0 +1,96 @@
|
|||||||
|
{
|
||||||
|
"name": "edx-cookie-cutter",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"description": "Starter app from the ground up",
|
||||||
|
"repository": "https://github.com/jaebradley/edx-cookie-cutter",
|
||||||
|
"scripts": {
|
||||||
|
"build": "NODE_ENV=production BABEL_ENV=production webpack --config=config/webpack.prod.config.js",
|
||||||
|
"deploy:gh-pages": "npm run build && gh-pages -d dist",
|
||||||
|
"is-es5": "es-check es5 ./dist/*.js",
|
||||||
|
"lint": "eslint --ext .js --ext .jsx .",
|
||||||
|
"precommit": "npm run lint",
|
||||||
|
"prepublishOnly": "npm run build",
|
||||||
|
"start": "NODE_ENV=development BABEL_ENV=development node_modules/.bin/webpack-dev-server --config=config/webpack.dev.config.js --progress",
|
||||||
|
"debug-test": "node --inspect-brk node_modules/.bin/jest --runInBand --coverage",
|
||||||
|
"test": "jest --coverage --passWithNoTests"
|
||||||
|
},
|
||||||
|
"license": "AGPL-3.0",
|
||||||
|
"dependencies": {
|
||||||
|
"@edx/edx-bootstrap": "^0.4.3",
|
||||||
|
"@edx/frontend-auth": "^1.0.3",
|
||||||
|
"@edx/paragon": "^3.1.1",
|
||||||
|
"babel-polyfill": "^6.26.0",
|
||||||
|
"classnames": "^2.2.5",
|
||||||
|
"email-prop-type": "^1.1.5",
|
||||||
|
"font-awesome": "^4.7.0",
|
||||||
|
"history": "^4.7.2",
|
||||||
|
"prop-types": "^15.5.10",
|
||||||
|
"react": "^16.2.0",
|
||||||
|
"react-dom": "^16.2.0",
|
||||||
|
"react-redux": "^5.0.7",
|
||||||
|
"react-router": "^4.2.0",
|
||||||
|
"react-router-dom": "^4.2.2",
|
||||||
|
"react-router-redux": "^5.0.0-alpha.9",
|
||||||
|
"redux": "^3.7.2",
|
||||||
|
"redux-devtools-extension": "^2.13.2",
|
||||||
|
"redux-logger": "^3.0.6",
|
||||||
|
"redux-thunk": "^2.2.0",
|
||||||
|
"whatwg-fetch": "^2.0.3"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"babel-cli": "^6.26.0",
|
||||||
|
"babel-eslint": "^8.2.2",
|
||||||
|
"babel-jest": "^22.4.0",
|
||||||
|
"babel-loader": "^7.1.2",
|
||||||
|
"babel-plugin-transform-class-properties": "^6.24.1",
|
||||||
|
"babel-plugin-transform-object-rest-spread": "^6.26.0",
|
||||||
|
"babel-preset-env": "^1.6.1",
|
||||||
|
"babel-preset-react": "^6.24.1",
|
||||||
|
"codecov": "^3.0.0",
|
||||||
|
"css-loader": "^0.28.9",
|
||||||
|
"enzyme": "^3.3.0",
|
||||||
|
"enzyme-adapter-react-16": "^1.1.1",
|
||||||
|
"es-check": "^2.0.2",
|
||||||
|
"eslint-config-edx": "^4.0.3",
|
||||||
|
"extract-text-webpack-plugin": "^4.0.0-beta.0",
|
||||||
|
"fetch-mock": "^6.3.0",
|
||||||
|
"file-loader": "^1.1.9",
|
||||||
|
"gh-pages": "^1.1.0",
|
||||||
|
"html-webpack-harddisk-plugin": "^0.2.0",
|
||||||
|
"html-webpack-plugin": "^3.0.3",
|
||||||
|
"husky": "^0.14.3",
|
||||||
|
"identity-obj-proxy": "^3.0.0",
|
||||||
|
"jest": "^22.4.0",
|
||||||
|
"node-sass": "^4.7.2",
|
||||||
|
"react-dev-utils": "^5.0.0",
|
||||||
|
"react-test-renderer": "^16.2.0",
|
||||||
|
"redux-mock-store": "^1.5.1",
|
||||||
|
"sass-loader": "^6.0.6",
|
||||||
|
"style-loader": "^0.20.2",
|
||||||
|
"webpack": "^4.1.0",
|
||||||
|
"webpack-cli": "^2.0.10",
|
||||||
|
"webpack-dev-server": "^3.1.0",
|
||||||
|
"webpack-merge": "^4.1.1"
|
||||||
|
},
|
||||||
|
"jest": {
|
||||||
|
"setupFiles": [
|
||||||
|
"./src/setupTest.js"
|
||||||
|
],
|
||||||
|
"moduleNameMapper": {
|
||||||
|
"\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$": "<rootDir>/__mocks__/fileMock.js",
|
||||||
|
"\\.(css|scss)$": "identity-obj-proxy"
|
||||||
|
},
|
||||||
|
"collectCoverageFrom": [
|
||||||
|
"src/**/*.{js,jsx}"
|
||||||
|
],
|
||||||
|
"coveragePathIgnorePatterns": [
|
||||||
|
"/node_modules/"
|
||||||
|
],
|
||||||
|
"transformIgnorePatterns": [
|
||||||
|
"/node_modules/(?!(@edx/paragon)/).*/"
|
||||||
|
],
|
||||||
|
"globals": {
|
||||||
|
"courseContext": {}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
7
public/index.html
Executable file
7
public/index.html
Executable file
@@ -0,0 +1,7 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html>
|
||||||
|
<head></head>
|
||||||
|
<body>
|
||||||
|
<div id="root"></div>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
2
src/App.scss
Executable file
2
src/App.scss
Executable file
@@ -0,0 +1,2 @@
|
|||||||
|
@import "~@edx/edx-bootstrap/sass/edx/theme";
|
||||||
|
@import "~bootstrap/scss/bootstrap";
|
||||||
37
src/components/CommentDetails/index.jsx
Executable file
37
src/components/CommentDetails/index.jsx
Executable file
@@ -0,0 +1,37 @@
|
|||||||
|
import React from 'react';
|
||||||
|
import PropTypes from 'prop-types';
|
||||||
|
import emailPropType from 'email-prop-type';
|
||||||
|
|
||||||
|
const CommentDetails = ({
|
||||||
|
id,
|
||||||
|
postId,
|
||||||
|
name,
|
||||||
|
email,
|
||||||
|
body,
|
||||||
|
}) => (
|
||||||
|
<ul>
|
||||||
|
<li>ID: {id}</li>
|
||||||
|
<li>Post ID: {postId}</li>
|
||||||
|
<li>Name: {name}</li>
|
||||||
|
<li>Email Address: {email}</li>
|
||||||
|
<li>Body: {body}</li>
|
||||||
|
</ul>
|
||||||
|
);
|
||||||
|
|
||||||
|
CommentDetails.defaultProps = {
|
||||||
|
id: null,
|
||||||
|
postId: null,
|
||||||
|
name: '',
|
||||||
|
email: 'example@example.com',
|
||||||
|
body: '',
|
||||||
|
};
|
||||||
|
|
||||||
|
CommentDetails.propTypes = {
|
||||||
|
id: PropTypes.number,
|
||||||
|
postId: PropTypes.number,
|
||||||
|
name: PropTypes.string,
|
||||||
|
email: emailPropType,
|
||||||
|
body: PropTypes.string,
|
||||||
|
};
|
||||||
|
|
||||||
|
export default CommentDetails;
|
||||||
76
src/components/CommentSearch/index.jsx
Executable file
76
src/components/CommentSearch/index.jsx
Executable file
@@ -0,0 +1,76 @@
|
|||||||
|
import React, { Component } from 'react';
|
||||||
|
import { InputText, Button, StatusAlert } from '@edx/paragon';
|
||||||
|
import PropTypes from 'prop-types';
|
||||||
|
import emailPropType from 'email-prop-type';
|
||||||
|
|
||||||
|
import CommentDetails from '../CommentDetails';
|
||||||
|
|
||||||
|
class CommentSearch extends Component {
|
||||||
|
constructor(props) {
|
||||||
|
super(props);
|
||||||
|
|
||||||
|
this.handleSubmit = this.handleSubmit.bind(this);
|
||||||
|
this.handleInputChange = this.handleInputChange.bind(this);
|
||||||
|
|
||||||
|
this.state = { commentId: '' };
|
||||||
|
}
|
||||||
|
|
||||||
|
handleSubmit() {
|
||||||
|
this.props.getComment(this.state.commentId);
|
||||||
|
}
|
||||||
|
|
||||||
|
handleInputChange(commentId) {
|
||||||
|
this.setState({ commentId });
|
||||||
|
}
|
||||||
|
|
||||||
|
render() {
|
||||||
|
return (
|
||||||
|
<div>
|
||||||
|
<StatusAlert
|
||||||
|
open={this.props.errorFetching}
|
||||||
|
dialog="Invalid Comment ID"
|
||||||
|
onClose={() => {}}
|
||||||
|
/>
|
||||||
|
<InputText
|
||||||
|
name="comment-id-input"
|
||||||
|
label="Input a Comment ID"
|
||||||
|
value=""
|
||||||
|
description="Comment ID to search by"
|
||||||
|
onChange={this.handleInputChange}
|
||||||
|
/>
|
||||||
|
<Button label="Search for Comment By ID" onClick={this.handleSubmit} />
|
||||||
|
{
|
||||||
|
this.props.commentDetails
|
||||||
|
&& !this.props.errorFetching
|
||||||
|
&& <CommentDetails {...this.props.commentDetails} />
|
||||||
|
}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
CommentSearch.defaultProps = {
|
||||||
|
commentDetails: {
|
||||||
|
id: null,
|
||||||
|
postId: null,
|
||||||
|
name: '',
|
||||||
|
email: 'example@example.com',
|
||||||
|
body: '',
|
||||||
|
},
|
||||||
|
getComment: () => {},
|
||||||
|
errorFetching: false,
|
||||||
|
};
|
||||||
|
|
||||||
|
CommentSearch.propTypes = {
|
||||||
|
commentDetails: PropTypes.shape({
|
||||||
|
id: PropTypes.number,
|
||||||
|
postId: PropTypes.number,
|
||||||
|
name: PropTypes.string,
|
||||||
|
email: emailPropType,
|
||||||
|
body: PropTypes.string,
|
||||||
|
}),
|
||||||
|
getComment: PropTypes.func,
|
||||||
|
errorFetching: PropTypes.bool,
|
||||||
|
};
|
||||||
|
|
||||||
|
export default CommentSearch;
|
||||||
91
src/components/ToggleablePosts/ToggleablePosts.test.jsx
Executable file
91
src/components/ToggleablePosts/ToggleablePosts.test.jsx
Executable file
@@ -0,0 +1,91 @@
|
|||||||
|
import React from 'react';
|
||||||
|
import { mount } from 'enzyme';
|
||||||
|
import { CheckBox } from '@edx/paragon';
|
||||||
|
|
||||||
|
import ToggleablePosts from './index';
|
||||||
|
|
||||||
|
describe('ToggleablePosts', () => {
|
||||||
|
let props;
|
||||||
|
let mountedPosts;
|
||||||
|
|
||||||
|
const toggleablePosts = () => {
|
||||||
|
if (!mountedPosts) {
|
||||||
|
mountedPosts = mount(<ToggleablePosts {...props} />);
|
||||||
|
}
|
||||||
|
|
||||||
|
return mountedPosts;
|
||||||
|
};
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
props = {
|
||||||
|
posts: undefined,
|
||||||
|
onChange: undefined,
|
||||||
|
};
|
||||||
|
mountedPosts = undefined;
|
||||||
|
});
|
||||||
|
|
||||||
|
it('always renders a div', () => {
|
||||||
|
const divs = toggleablePosts().find('div');
|
||||||
|
expect(divs.length).toBeGreaterThan(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('always renders a single h1', () => {
|
||||||
|
const h1s = toggleablePosts().find('h1');
|
||||||
|
expect(h1s.length).toBe(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('always renders a CheckBox', () => {
|
||||||
|
const component = toggleablePosts();
|
||||||
|
const checkboxes = component.find(CheckBox);
|
||||||
|
|
||||||
|
expect(checkboxes.length).toBe(1);
|
||||||
|
|
||||||
|
const checkbox = checkboxes.first();
|
||||||
|
expect(checkbox.prop('name')).toBe('activate-posts');
|
||||||
|
expect(checkbox.prop('label')).toBe('See Posts');
|
||||||
|
expect(checkbox.prop('checked')).toBe(false);
|
||||||
|
expect(checkbox.prop('onChange')).toBe(component.instance().handleCheck);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('sets checked from false to true and calls prop getPosts', () => {
|
||||||
|
const mockedGetPosts = jest.fn();
|
||||||
|
props.getPosts = mockedGetPosts;
|
||||||
|
|
||||||
|
const component = toggleablePosts();
|
||||||
|
component.instance().handleCheck();
|
||||||
|
|
||||||
|
expect(component.state('checked')).toBe(true);
|
||||||
|
expect(mockedGetPosts).toHaveBeenCalledTimes(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not render posts when unchecked', () => {
|
||||||
|
const component = toggleablePosts();
|
||||||
|
|
||||||
|
expect(component.state('checked')).toBe(false);
|
||||||
|
expect(component.find('li').length).toBe(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does render posts when checked', () => {
|
||||||
|
const posts = [];
|
||||||
|
for (let i = 0; i < 15; i += 1) {
|
||||||
|
posts.push({
|
||||||
|
id: `id-${i}`,
|
||||||
|
title: `title-${i}`,
|
||||||
|
body: `body-${i}`,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
props.posts = posts;
|
||||||
|
|
||||||
|
const component = toggleablePosts();
|
||||||
|
component.setState({ checked: true });
|
||||||
|
|
||||||
|
const listItems = component.find('li');
|
||||||
|
|
||||||
|
expect(listItems.length).toBe(10);
|
||||||
|
|
||||||
|
listItems.forEach((li, index) => {
|
||||||
|
expect(li.key()).toBe(`id-${index}`);
|
||||||
|
expect(li.html()).toBe(`<li><div class="post"><h3>title-${index}</h3><span>body-${index}</span></div></li>`);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
93
src/components/ToggleablePosts/index.jsx
Executable file
93
src/components/ToggleablePosts/index.jsx
Executable file
@@ -0,0 +1,93 @@
|
|||||||
|
import React from 'react';
|
||||||
|
import PropTypes from 'prop-types';
|
||||||
|
import { CheckBox } from '@edx/paragon';
|
||||||
|
|
||||||
|
const PostItem = ({ title, body }) => (
|
||||||
|
<div className="post">
|
||||||
|
<h3>{title}</h3>
|
||||||
|
<span>{body}</span>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
|
||||||
|
const PostsList = ({ posts }) => (
|
||||||
|
<ul>
|
||||||
|
{
|
||||||
|
posts
|
||||||
|
.slice(0, 10)
|
||||||
|
.map(post => (
|
||||||
|
<li key={post.id}>
|
||||||
|
<PostItem title={post.title} body={post.body} />
|
||||||
|
</li>
|
||||||
|
))
|
||||||
|
}
|
||||||
|
</ul>
|
||||||
|
);
|
||||||
|
|
||||||
|
class ToggleablePosts extends React.Component {
|
||||||
|
constructor(props) {
|
||||||
|
super(props);
|
||||||
|
|
||||||
|
this.handleCheck = this.handleCheck.bind(this);
|
||||||
|
|
||||||
|
this.state = {
|
||||||
|
checked: false,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
handleCheck() {
|
||||||
|
this.setState({ checked: !this.state.checked });
|
||||||
|
this.props.getPosts();
|
||||||
|
}
|
||||||
|
|
||||||
|
render() {
|
||||||
|
return (
|
||||||
|
<div>
|
||||||
|
<h1>Posts</h1>
|
||||||
|
<div>
|
||||||
|
<CheckBox
|
||||||
|
name="activate-posts"
|
||||||
|
label="See Posts"
|
||||||
|
checked={this.state.checked}
|
||||||
|
onChange={this.handleCheck}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
{
|
||||||
|
this.state.checked
|
||||||
|
&& <PostsList posts={this.props.posts} />
|
||||||
|
}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
PostItem.defaultProps = {
|
||||||
|
title: '',
|
||||||
|
body: '',
|
||||||
|
};
|
||||||
|
|
||||||
|
PostItem.propTypes = {
|
||||||
|
title: PropTypes.string,
|
||||||
|
body: PropTypes.string,
|
||||||
|
};
|
||||||
|
|
||||||
|
PostsList.defaultProps = {
|
||||||
|
posts: [],
|
||||||
|
};
|
||||||
|
|
||||||
|
PostsList.propTypes = {
|
||||||
|
posts: PropTypes.arrayOf(PropTypes.object),
|
||||||
|
};
|
||||||
|
|
||||||
|
ToggleablePosts.defaultProps = {
|
||||||
|
posts: [],
|
||||||
|
getPosts: () => {},
|
||||||
|
};
|
||||||
|
|
||||||
|
ToggleablePosts.propTypes = {
|
||||||
|
posts: PropTypes.arrayOf(PropTypes.object),
|
||||||
|
getPosts: PropTypes.func,
|
||||||
|
};
|
||||||
|
|
||||||
|
export default ToggleablePosts;
|
||||||
24
src/containers/CommentSearchPage/index.jsx
Executable file
24
src/containers/CommentSearchPage/index.jsx
Executable file
@@ -0,0 +1,24 @@
|
|||||||
|
import { connect } from 'react-redux';
|
||||||
|
|
||||||
|
import CommentSearch from '../../components/CommentSearch';
|
||||||
|
import { fetchComment } from '../../data/actions/comment';
|
||||||
|
|
||||||
|
const mapStateToProps = state => (
|
||||||
|
{
|
||||||
|
commentDetails: state.comment.details,
|
||||||
|
errorFetching: state.comment.errorFetching,
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
const mapDispatchToProps = dispatch => (
|
||||||
|
{
|
||||||
|
getComment: commentId => dispatch(fetchComment(commentId)),
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
const CommentSearchPage = connect(
|
||||||
|
mapStateToProps,
|
||||||
|
mapDispatchToProps,
|
||||||
|
)(CommentSearch);
|
||||||
|
|
||||||
|
export default CommentSearchPage;
|
||||||
1
src/containers/DisclosurePage/DisclosurePage.scss
Executable file
1
src/containers/DisclosurePage/DisclosurePage.scss
Executable file
@@ -0,0 +1 @@
|
|||||||
|
// Fill this later
|
||||||
13
src/containers/DisclosurePage/DisclosurePage.test.jsx
Executable file
13
src/containers/DisclosurePage/DisclosurePage.test.jsx
Executable file
@@ -0,0 +1,13 @@
|
|||||||
|
import React from 'react';
|
||||||
|
import { shallow } from 'enzyme';
|
||||||
|
|
||||||
|
import DisclosurePage from './index';
|
||||||
|
|
||||||
|
describe('correctly renders', () => {
|
||||||
|
it('renders Disclosure Page', () => {
|
||||||
|
const wrapper = shallow(<DisclosurePage />);
|
||||||
|
const expected = '<div><h1 class="alert alert-primary">Some Disclosure Page</h1><p>Blahblahblahblahblahblah</p><ul><li>Agree to this</li><li>Agree to this</li><li>Also agree to this</li></ul></div>';
|
||||||
|
expect(wrapper.html()).toEqual(expected);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
15
src/containers/DisclosurePage/index.jsx
Executable file
15
src/containers/DisclosurePage/index.jsx
Executable file
@@ -0,0 +1,15 @@
|
|||||||
|
import React from 'react';
|
||||||
|
|
||||||
|
const DisclosurePage = () => (
|
||||||
|
<div>
|
||||||
|
<h1 className="alert alert-primary">Some Disclosure Page</h1>
|
||||||
|
<p>Blahblahblahblahblahblah</p>
|
||||||
|
<ul>
|
||||||
|
<li>Agree to this</li>
|
||||||
|
<li>Agree to this</li>
|
||||||
|
<li>Also agree to this</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
|
||||||
|
export default DisclosurePage;
|
||||||
23
src/containers/PostsPage/index.jsx
Executable file
23
src/containers/PostsPage/index.jsx
Executable file
@@ -0,0 +1,23 @@
|
|||||||
|
import { connect } from 'react-redux';
|
||||||
|
|
||||||
|
import ToggleablePosts from '../../components/ToggleablePosts';
|
||||||
|
import { fetchPosts } from '../../data/actions/posts';
|
||||||
|
|
||||||
|
const mapStateToProps = state => (
|
||||||
|
{
|
||||||
|
posts: state.posts.posts,
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
const mapDispatchToProps = dispatch => (
|
||||||
|
{
|
||||||
|
getPosts: () => dispatch(fetchPosts()),
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
const PostsPage = connect(
|
||||||
|
mapStateToProps,
|
||||||
|
mapDispatchToProps,
|
||||||
|
)(ToggleablePosts);
|
||||||
|
|
||||||
|
export default PostsPage;
|
||||||
38
src/data/actions/comment.js
Executable file
38
src/data/actions/comment.js
Executable file
@@ -0,0 +1,38 @@
|
|||||||
|
import 'whatwg-fetch';
|
||||||
|
import {
|
||||||
|
STARTED_FETCHING_COMMENT,
|
||||||
|
FINISHED_FETCHING_COMMENT,
|
||||||
|
ERROR_FETCHING_COMMENT,
|
||||||
|
GET_COMMENT,
|
||||||
|
} from '../constants/actionTypes/comment';
|
||||||
|
|
||||||
|
const startedFetchingComment = () => ({ type: STARTED_FETCHING_COMMENT });
|
||||||
|
const finishedFetchingComment = () => ({ type: FINISHED_FETCHING_COMMENT });
|
||||||
|
const errorFetchingComment = () => ({ type: ERROR_FETCHING_COMMENT });
|
||||||
|
const getComment = comment => ({ type: GET_COMMENT, comment });
|
||||||
|
const fetchComment = commentId => (
|
||||||
|
(dispatch) => {
|
||||||
|
dispatch(startedFetchingComment());
|
||||||
|
return fetch(`https://jsonplaceholder.typicode.com/comments/${commentId}`)
|
||||||
|
.then((response) => {
|
||||||
|
if (response.ok) {
|
||||||
|
return response.json();
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new Error();
|
||||||
|
})
|
||||||
|
.then((data) => {
|
||||||
|
dispatch(getComment(data));
|
||||||
|
dispatch(finishedFetchingComment());
|
||||||
|
})
|
||||||
|
.catch(() => dispatch(errorFetchingComment()));
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
export {
|
||||||
|
startedFetchingComment,
|
||||||
|
finishedFetchingComment,
|
||||||
|
errorFetchingComment,
|
||||||
|
getComment,
|
||||||
|
fetchComment,
|
||||||
|
};
|
||||||
46
src/data/actions/posts.js
Executable file
46
src/data/actions/posts.js
Executable file
@@ -0,0 +1,46 @@
|
|||||||
|
import 'whatwg-fetch';
|
||||||
|
|
||||||
|
import {
|
||||||
|
STARTED_FETCHING_POSTS,
|
||||||
|
FINISHED_FETCHING_POSTS,
|
||||||
|
GET_POSTS,
|
||||||
|
} from '../constants/actionTypes/posts';
|
||||||
|
|
||||||
|
const startedFetchingPosts = () => (
|
||||||
|
{
|
||||||
|
type: STARTED_FETCHING_POSTS,
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
const finishedFetchingPosts = () => (
|
||||||
|
{
|
||||||
|
type: FINISHED_FETCHING_POSTS,
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
const getPosts = posts => (
|
||||||
|
{
|
||||||
|
type: GET_POSTS,
|
||||||
|
posts,
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
const fetchPosts = () => (
|
||||||
|
(dispatch) => {
|
||||||
|
dispatch(startedFetchingPosts());
|
||||||
|
return fetch('https://jsonplaceholder.typicode.com/posts')
|
||||||
|
// TODO: handle response error
|
||||||
|
.then(response => response.json())
|
||||||
|
.then((data) => {
|
||||||
|
dispatch(getPosts(data));
|
||||||
|
dispatch(finishedFetchingPosts());
|
||||||
|
});
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
export {
|
||||||
|
startedFetchingPosts,
|
||||||
|
finishedFetchingPosts,
|
||||||
|
getPosts,
|
||||||
|
fetchPosts,
|
||||||
|
};
|
||||||
65
src/data/actions/posts.test.js
Executable file
65
src/data/actions/posts.test.js
Executable file
@@ -0,0 +1,65 @@
|
|||||||
|
import configureMockStore from 'redux-mock-store';
|
||||||
|
import thunk from 'redux-thunk';
|
||||||
|
import fetchMock from 'fetch-mock';
|
||||||
|
|
||||||
|
import {
|
||||||
|
startedFetchingPosts,
|
||||||
|
finishedFetchingPosts,
|
||||||
|
getPosts,
|
||||||
|
fetchPosts,
|
||||||
|
} from './posts';
|
||||||
|
import {
|
||||||
|
STARTED_FETCHING_POSTS,
|
||||||
|
GET_POSTS,
|
||||||
|
FINISHED_FETCHING_POSTS,
|
||||||
|
} from '../constants/actionTypes/posts';
|
||||||
|
|
||||||
|
const mockStore = configureMockStore([thunk]);
|
||||||
|
|
||||||
|
describe('actions', () => {
|
||||||
|
afterEach(() => {
|
||||||
|
fetchMock.reset();
|
||||||
|
fetchMock.restore();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('sends started fetching post action', () => {
|
||||||
|
const expected = { type: STARTED_FETCHING_POSTS };
|
||||||
|
expect(startedFetchingPosts()).toEqual(expected);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('sends finished fetching posts', () => {
|
||||||
|
const expected = { type: FINISHED_FETCHING_POSTS };
|
||||||
|
expect(finishedFetchingPosts()).toEqual(expected);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('sends posts', () => {
|
||||||
|
const data = 'data';
|
||||||
|
const expected = { type: GET_POSTS, posts: data };
|
||||||
|
expect(getPosts(data)).toEqual(expected);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('fetches posts', () => {
|
||||||
|
const posts = [
|
||||||
|
{
|
||||||
|
id: 1,
|
||||||
|
title: 'title',
|
||||||
|
body: 'body',
|
||||||
|
},
|
||||||
|
];
|
||||||
|
fetchMock.getOnce('https://jsonplaceholder.typicode.com/posts', {
|
||||||
|
body: JSON.stringify({ posts }),
|
||||||
|
headers: { 'content-type': 'application/json' },
|
||||||
|
});
|
||||||
|
const store = mockStore({ posts: [] });
|
||||||
|
|
||||||
|
const expectedActions = [
|
||||||
|
{ type: STARTED_FETCHING_POSTS },
|
||||||
|
{ type: GET_POSTS, posts: { posts } },
|
||||||
|
{ type: FINISHED_FETCHING_POSTS },
|
||||||
|
];
|
||||||
|
|
||||||
|
return store.dispatch(fetchPosts()).then(() => {
|
||||||
|
expect(store.getActions()).toEqual(expectedActions);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
11
src/data/constants/actionTypes/comment.js
Executable file
11
src/data/constants/actionTypes/comment.js
Executable file
@@ -0,0 +1,11 @@
|
|||||||
|
const STARTED_FETCHING_COMMENT = 'STARTED_FETCHING_COMMENT';
|
||||||
|
const FINISHED_FETCHING_COMMENT = 'FINISHED_FETCHING_COMMENT';
|
||||||
|
const ERROR_FETCHING_COMMENT = 'ERROR_FETCHING_COMMENT';
|
||||||
|
const GET_COMMENT = 'GET_COMMENT';
|
||||||
|
|
||||||
|
export {
|
||||||
|
STARTED_FETCHING_COMMENT,
|
||||||
|
FINISHED_FETCHING_COMMENT,
|
||||||
|
ERROR_FETCHING_COMMENT,
|
||||||
|
GET_COMMENT,
|
||||||
|
};
|
||||||
9
src/data/constants/actionTypes/posts.js
Executable file
9
src/data/constants/actionTypes/posts.js
Executable file
@@ -0,0 +1,9 @@
|
|||||||
|
const STARTED_FETCHING_POSTS = 'STARTED_FETCHING_POSTS';
|
||||||
|
const GET_POSTS = 'GET_POSTS';
|
||||||
|
const FINISHED_FETCHING_POSTS = 'FINISHED_FETCHING_POSTS';
|
||||||
|
|
||||||
|
export {
|
||||||
|
STARTED_FETCHING_POSTS,
|
||||||
|
GET_POSTS,
|
||||||
|
FINISHED_FETCHING_POSTS,
|
||||||
|
};
|
||||||
46
src/data/reducers/comment.js
Executable file
46
src/data/reducers/comment.js
Executable file
@@ -0,0 +1,46 @@
|
|||||||
|
import {
|
||||||
|
STARTED_FETCHING_COMMENT,
|
||||||
|
ERROR_FETCHING_COMMENT,
|
||||||
|
GET_COMMENT,
|
||||||
|
} from '../constants/actionTypes/comment';
|
||||||
|
|
||||||
|
const initialState = {
|
||||||
|
details: {
|
||||||
|
id: null,
|
||||||
|
postId: null,
|
||||||
|
name: '',
|
||||||
|
email: 'example@example.com',
|
||||||
|
body: '',
|
||||||
|
},
|
||||||
|
startedFetching: false,
|
||||||
|
finishedFetching: false,
|
||||||
|
errorFetching: false,
|
||||||
|
};
|
||||||
|
|
||||||
|
const comment = (state = initialState, action) => {
|
||||||
|
switch (action.type) {
|
||||||
|
case GET_COMMENT:
|
||||||
|
return {
|
||||||
|
...state,
|
||||||
|
details: { ...action.comment },
|
||||||
|
finishedFetching: true,
|
||||||
|
errorFetching: false,
|
||||||
|
};
|
||||||
|
case STARTED_FETCHING_COMMENT:
|
||||||
|
return {
|
||||||
|
...state,
|
||||||
|
startedFetching: true,
|
||||||
|
finishedFetching: false,
|
||||||
|
};
|
||||||
|
case ERROR_FETCHING_COMMENT:
|
||||||
|
return {
|
||||||
|
...state,
|
||||||
|
finishedFetching: true,
|
||||||
|
errorFetching: true,
|
||||||
|
};
|
||||||
|
default:
|
||||||
|
return state;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
export default comment;
|
||||||
11
src/data/reducers/index.js
Executable file
11
src/data/reducers/index.js
Executable file
@@ -0,0 +1,11 @@
|
|||||||
|
import { combineReducers } from 'redux';
|
||||||
|
|
||||||
|
import posts from './posts';
|
||||||
|
import comment from './comment';
|
||||||
|
|
||||||
|
const rootReducer = combineReducers({
|
||||||
|
posts,
|
||||||
|
comment,
|
||||||
|
});
|
||||||
|
|
||||||
|
export default rootReducer;
|
||||||
31
src/data/reducers/posts.js
Executable file
31
src/data/reducers/posts.js
Executable file
@@ -0,0 +1,31 @@
|
|||||||
|
import {
|
||||||
|
GET_POSTS,
|
||||||
|
STARTED_FETCHING_POSTS,
|
||||||
|
FINISHED_FETCHING_POSTS,
|
||||||
|
} from '../constants/actionTypes/posts';
|
||||||
|
|
||||||
|
const posts = (state = { posts: [], startedFetching: false, finishedFetching: false }, action) => {
|
||||||
|
switch (action.type) {
|
||||||
|
case GET_POSTS:
|
||||||
|
return {
|
||||||
|
...state,
|
||||||
|
posts: action.posts,
|
||||||
|
};
|
||||||
|
case STARTED_FETCHING_POSTS:
|
||||||
|
return {
|
||||||
|
...state,
|
||||||
|
startedFetching: true,
|
||||||
|
finishedFetching: false,
|
||||||
|
};
|
||||||
|
case FINISHED_FETCHING_POSTS:
|
||||||
|
return {
|
||||||
|
...state,
|
||||||
|
startedFetching: false,
|
||||||
|
finishedFetching: true,
|
||||||
|
};
|
||||||
|
default:
|
||||||
|
return state;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
export default posts;
|
||||||
45
src/data/reducers/posts.test.js
Executable file
45
src/data/reducers/posts.test.js
Executable file
@@ -0,0 +1,45 @@
|
|||||||
|
import posts from './posts';
|
||||||
|
import {
|
||||||
|
GET_POSTS,
|
||||||
|
STARTED_FETCHING_POSTS,
|
||||||
|
FINISHED_FETCHING_POSTS,
|
||||||
|
} from '../constants/actionTypes/posts';
|
||||||
|
|
||||||
|
const initialState = {
|
||||||
|
posts: [],
|
||||||
|
startedFetching: false,
|
||||||
|
finishedFetching: false,
|
||||||
|
};
|
||||||
|
|
||||||
|
describe('posts reducer', () => {
|
||||||
|
it('has initial state', () => {
|
||||||
|
expect(posts(undefined, {})).toEqual(initialState);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('adds posts', () => {
|
||||||
|
const fetchedPosts = [1, 2, 3];
|
||||||
|
const expected = {
|
||||||
|
...initialState,
|
||||||
|
posts: fetchedPosts,
|
||||||
|
};
|
||||||
|
expect(posts(undefined, { type: GET_POSTS, posts: fetchedPosts })).toEqual(expected);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('updates started fetching posts state', () => {
|
||||||
|
const expected = {
|
||||||
|
...initialState,
|
||||||
|
startedFetching: true,
|
||||||
|
finishedFetching: false,
|
||||||
|
};
|
||||||
|
expect(posts(undefined, { type: STARTED_FETCHING_POSTS })).toEqual(expected);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('updates finished fetching posts state', () => {
|
||||||
|
const expected = {
|
||||||
|
...initialState,
|
||||||
|
startedFetching: false,
|
||||||
|
finishedFetching: true,
|
||||||
|
};
|
||||||
|
expect(posts(undefined, { type: FINISHED_FETCHING_POSTS })).toEqual(expected);
|
||||||
|
});
|
||||||
|
});
|
||||||
15
src/data/store.js
Executable file
15
src/data/store.js
Executable file
@@ -0,0 +1,15 @@
|
|||||||
|
import { applyMiddleware, createStore } from 'redux';
|
||||||
|
import thunkMiddleware from 'redux-thunk';
|
||||||
|
import { composeWithDevTools } from 'redux-devtools-extension/logOnlyInProduction';
|
||||||
|
import { createLogger } from 'redux-logger';
|
||||||
|
|
||||||
|
import reducers from './reducers';
|
||||||
|
|
||||||
|
const loggerMiddleware = createLogger();
|
||||||
|
|
||||||
|
const store = createStore(
|
||||||
|
reducers,
|
||||||
|
composeWithDevTools(applyMiddleware(thunkMiddleware, loggerMiddleware)),
|
||||||
|
);
|
||||||
|
|
||||||
|
export default store;
|
||||||
40
src/index.jsx
Executable file
40
src/index.jsx
Executable file
@@ -0,0 +1,40 @@
|
|||||||
|
import 'babel-polyfill';
|
||||||
|
import React from 'react';
|
||||||
|
import ReactDOM from 'react-dom';
|
||||||
|
import { BrowserRouter as Router, Route, Switch, Link } from 'react-router-dom';
|
||||||
|
import { Provider } from 'react-redux';
|
||||||
|
|
||||||
|
import PostsPage from './containers/PostsPage';
|
||||||
|
import CommentSearchPage from './containers/CommentSearchPage';
|
||||||
|
import DisclosurePage from './containers/DisclosurePage';
|
||||||
|
import store from './data/store';
|
||||||
|
import './App.scss';
|
||||||
|
|
||||||
|
const App = () => (
|
||||||
|
<Provider store={store}>
|
||||||
|
<Router>
|
||||||
|
<div>
|
||||||
|
<header>
|
||||||
|
<nav>
|
||||||
|
<ul className="nav">
|
||||||
|
<li className="nav-item"><Link className="nav-link" to="/">Home</Link></li>
|
||||||
|
<li className="nav-item"><Link className="nav-link" to="/posts">Posts</Link></li>
|
||||||
|
<li className="nav-item"><Link className="nav-link" to="/disclosure">Disclosure</Link></li>
|
||||||
|
<li className="nav-item"><Link className="nav-link" to="/comment-search">Comment Search</Link></li>
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
</header>
|
||||||
|
<main>
|
||||||
|
<Switch>
|
||||||
|
<Route exact path="/" component={() => <span>Hello World</span>} />
|
||||||
|
<Route path="/posts" component={PostsPage} />
|
||||||
|
<Route path="/disclosure" component={DisclosurePage} />
|
||||||
|
<Route path="/comment-search" component={CommentSearchPage} />
|
||||||
|
</Switch>
|
||||||
|
</main>
|
||||||
|
</div>
|
||||||
|
</Router>
|
||||||
|
</Provider>
|
||||||
|
);
|
||||||
|
|
||||||
|
ReactDOM.render(<App />, document.getElementById('root'));
|
||||||
6
src/setupTest.js
Executable file
6
src/setupTest.js
Executable file
@@ -0,0 +1,6 @@
|
|||||||
|
/* eslint-disable import/no-extraneous-dependencies */
|
||||||
|
|
||||||
|
import Enzyme from 'enzyme';
|
||||||
|
import Adapter from 'enzyme-adapter-react-16';
|
||||||
|
|
||||||
|
Enzyme.configure({ adapter: new Adapter() });
|
||||||
Reference in New Issue
Block a user