Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 19 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,33 @@
![CF](http://i.imgur.com/7v5ASc8.png) LAB
=================================================
# ![CF](http://i.imgur.com/7v5ASc8.png) Block Project

## Project Name
## RESTy

### Author: Student/Group Name
### Author: Jagdeep Singh

### Links and Resources
* [submission PR](http://xyz.com)
* [travis](http://xyz.com)
* [back-end](http://xyz.com) (when applicable)
* [front-end](http://xyz.com) (when applicable)

#### Documentation
* [api docs](http://xyz.com) (API servers)
* [jsdoc](http://xyz.com) (Server assignments)
* [styleguide](http://xyz.com) (React assignments)

### Modules
#### `modulename.js`
##### Exported Values and Methods
- [submission PR](http://xyz.com)
- [travis](http://xyz.com)
- [front-end](http://xyz.com) (when applicable)

###### `foo(thing) -> string`
Usage Notes or examples
#### Documentation

###### `bar(array) -> array`
Usage Notes or examples
- [styleguide](http://xyz.com) (React assignments)

### Setup
#### `.env` requirements
* `PORT` - Port Number
* `MONGODB_URI` - URL to the running mongo instance/db

#### Running the app
* `npm start`
* Endpoint: `/foo/bar/`
* Returns a JSON object with abc in it.
* Endpoint: `/bing/zing/`
* Returns a JSON object with xyz in it.


- `npm start`

#### Tests
* How do you run tests?
* What assertions were made?
* What assertions need to be / should be made?

- How do you run tests? `npm test`
<!-- - What assertions were made? -->
<!-- - What assertions need to be / should be made? -->

#### UML
Link to an image of the UML for your application and response to events

<!-- Link to an image of the UML for your application and response to events -->

![UML](assets/uml.jpeg)
Binary file added assets/uml.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
181 changes: 176 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@
"node-sass": "^4.12.0",
"react": "^16.8.6",
"react-dom": "^16.8.6",
"react-json-view": "^1.19.1",
"react-scripts": "3.0.1",
"react-test-renderer": "^16.8.6"
"react-test-renderer": "^16.8.6",
"superagent": "^5.1.0"
},
"devDependencies": {
"eslint-config-airbnb-base": "^13.1.0",
Expand All @@ -20,7 +22,8 @@
"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test",
"eject": "react-scripts eject"
"eject": "react-scripts eject",
"lint": "eslint src/**/*.js"
},
"eslintConfig": {
"extends": "react-app"
Expand Down
Loading