https://github.com/jpmcb/recoverme
CS 361 - Basic implementation and skeleton for the RecoverME application
https://github.com/jpmcb/recoverme
Last synced: about 1 year ago
JSON representation
CS 361 - Basic implementation and skeleton for the RecoverME application
- Host: GitHub
- URL: https://github.com/jpmcb/recoverme
- Owner: jpmcb
- License: mit
- Created: 2018-05-19T16:41:58.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-08T23:48:52.000Z (about 8 years ago)
- Last Synced: 2025-02-09T00:13:49.623Z (over 1 year ago)
- Language: Python
- Size: 33.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RecoverME
CS 361 - Basic implementation and skeleton for the RecoverME application
## Set up local dev enviroment:
1. Pull from this githup repo
2. Install the local node modules using `npm install`
- This will install the needed view and engine modules to run the app
3. Start the application with `node server.js`
- You may now navigate to a locally running version of the application at `localhost:3000`
## Basic skeleton of the App:
1. `server.js` is the entry point for the node app. Any route handlers or various server logic should go here.
2. `public` holds the various static resources for the app (CSS, images, etc). To access these resources, ensure that the full file path is specified (see main.handlebars for an example)
3. `views` holds the various handlebars views that can be dynamically generated
## To add a node module:
1. Install the module using `npm install `
2. `require` the node module in server.js
3. Use the various modules components
## Integrated Testing
1. Ensure that you `export` your node module so that your funcitons are reachable. Import your module into `test.js`
2. Add tests to the `tests.js` file with some kind of function calling your imported methods / functions
3. Place some kind of try / assert / catch block like so:
```
try{
assert.equal(sum1, sum2);
console.log('Passed.');
} catch (error) {
console.error('Failed.');
}
```
If an error is thrown, this will cause the integrated tests to fail!
4. Call your testing function at the end of tests.js