generated from saoud/jsEnvTemplate
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
adding instructions to README as well as authors, also added the corr…
…ect repo to package.json
- Loading branch information
Showing
5 changed files
with
29 additions
and
84 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,4 +3,4 @@ node_modules/ | |
dist/ | ||
coverage/ | ||
.vscode/ | ||
.env | ||
.env |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
@@ -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 |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters