Skip to content

Commit

Permalink
adding instructions to README as well as authors, also added the corr…
Browse files Browse the repository at this point in the history
…ect repo to package.json
  • Loading branch information
saoud committed Mar 28, 2021
1 parent f506ee4 commit 90ac211
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 84 deletions.
Empty file removed .env
Empty file.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ node_modules/
dist/
coverage/
.vscode/
.env
.env
36 changes: 20 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
# Title
# Jeopardy! Simulator
####
#### Project initiated:
#### By Saoud Rana
#### Project initiated: 3-28-21
#### By Saoud Rana, Jesse Callahan, Laurie Waller, Shanen Cross and Collin Chapman
## Project Description


## Specs

```
Describe:
Test:
Expect:
```
```This api: https://jservice.io/ gives trivia questions much like jeopardy.
We could try to set up a table of questions much like the iconic Jeopardy! board.
We could use CSS to mimic the little blue Jeopardy! squares.
This project would probably have two MVP avenues we could explore listed below:```
## Technologies Used
* Javascript ES6
Expand All @@ -25,17 +21,25 @@ Expect:
* Bootstrap
## Set up / Installation requirements
* Open up a terminal and clone the repo
* Navigate to the folder containing the files from the repo and type `code . `
* You can also use [LiveServer](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer)
* Open the terminal in your machine
* Navigate to the directory where you would like to save this project
* Clone the project with $ git clone LINK TO GITHUB
* Recreate this project's environment with $ `npm install`
* Create a file to store variables you want to keep secret $ touch .env
* Create production environment with terminal command $ `npm run build`
* Start server with command $ `npm run start`
## Known Bugs
* No known bugs
## Notes
## License
* [MIT](https://github.com/saoud/html-template/blob/main/LICENSE)
* Copyright 2021 Saoud Rana
* [MIT](https://github.com/saoud/Team-Week-Project-Jeopardy-Simulator/blob/main/LICENSE)
* Copyright 2021 Saoud Rana, Jesse Callahan, Laurie Waller, Shanen Cross and Collin Chapman
## Contact
Saoud Rana [email protected]
Jesse Callahan
Laurie waller
Shanen Cross
Collin Chapman
65 changes: 3 additions & 62 deletions package-lock.json

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

10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "jsenvtemplate",
"name": "Team-Week-Project-Jeopardy-Simulator",
"version": "1.0.0",
"description": "",
"main": "index.js",
Expand All @@ -11,15 +11,15 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/saoud/jsEnvTemplate.git"
"url": "git+https://github.com/saoud/Team-Week-Project-Jeopardy-Simulator.git"
},
"keywords": [],
"author": "Saoud Rana",
"author": "Saoud Rana, Jesse Callahan, Laurie Waller, Shanen Cross and Collin Chapman",
"license": "MIT",
"bugs": {
"url": "https://github.com/saoud/jsEnvTemplate/issues"
"url": "https://github.com/saoud/Team-Week-Project-Jeopardy-Simulator/issues"
},
"homepage": "https://github.com/saoud/jsEnvTemplate#readme",
"homepage": "https://github.com/saoud/Team-Week-Project-Jeopardy-Simulator#readme",
"devDependencies": {
"@babel/core": "^7.6.4",
"@babel/plugin-transform-modules-commonjs": "^7.6.0",
Expand Down

0 comments on commit 90ac211

Please sign in to comment.