Development Environment Homework Starter Code
A minimal project used to check that everyone's development environment is set up for the 250 section of the CSCE 310 course at UNL.
Quick Start
Recursively clone this repository and cd
into the root folder:
$ git clone --recursive git@git.unl.edu:csce-310/development-environment-homework.git
$ cd development-environment-homework
(If you forget --recursive
when cloning, you can cd
into your clone and run
git submodule update --init --recursive
instead.)
Install dependencies:
$ npm install
Optionally run the linter and the test suite:
$ npm run lint
$ npm run test
Folders and Files
The folders and files in the starter code are briefly described below.
Submodules
- The Git submodule
eslint-config
contains the ESLint configuration for the coding style used in thedevelopment-environment-homework
project.
General Configuration
-
The file
development-environment-homework/.gitignore
prevents non-source-code files from being accidentally committed to the repository. -
The file
development-environment-homework/package.json
describes the project and its dependencies. It can be edited to customize the inputs and processes used in various software lifecyle tasks like linting, testing, or deploying. -
The file
development-environment-homework/package-lock.json
records the exact set of dependencies used to satisfy the requirements indevelopment-environment-homework/package.json
. It should not be hand-edited; use commands likenpm install
ornpm uninstall
from thedevelopment-environment-homework
directory to make changes. -
The folder
development-environment-homework/node_modules
contains the dependencies installed bynpm
.
Code Under Test
- The file
development-environment-homework/src/helloWorld.js
is an example of a simple implementation that can be unit tested.
Test Code
- The file
development-environment-homework/src/helloWorld.test.js
demonstrates a Jest unit test.