Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bhavyagada/ucrstar_game
Game for UCR Star (https://star.cs.ucr.edu)
https://github.com/bhavyagada/ucrstar_game
Last synced: 14 days ago
JSON representation
Game for UCR Star (https://star.cs.ucr.edu)
- Host: GitHub
- URL: https://github.com/bhavyagada/ucrstar_game
- Owner: bhavyagada
- Created: 2023-01-28T19:06:03.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-18T00:57:55.000Z (over 1 year ago)
- Last Synced: 2024-11-11T19:12:10.687Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 79.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# UCR Star Game
# for development (mac)
## setup pre-requisites
Install homebrew package manager to make installations/upgrades easier
```console
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```
then install node, python3
```console
brew install node [email protected]
```
and mongoDB
```console
brew tap mongodb/brew
brew install mongodb-community
```
## import sample questions (data.json) into mongoDB
Edit the file `data.json` and adjust the date of at least one question to point to today's date.
Run the following command
```console
mongoimport -d ucrstar -c game --file data.json --jsonArray --drop
```
Alternatively, the MongoDB Compass GUI application can be used.
Create a database ```ucrstar```, add a collection ```game``` to it and use the "ADD DATA" button to import the ```data.json``` file.
## start the server
Move to the subdirectory ```server/```
### install dependencies and run locally
Run the following commands
```console
pip install -r requirements.txt
python3 -m http.server --cgi
```
## start the client
Move to the subdirectory ```client/```
### env files
In the ```client/``` subdirectory, create ```.env.development``` and ```.env.production``` to store environment specific variables to be used in the application.
For now, it only contains the following keys:
VITE_BASE_URL="http://localhost:8000" (for development) and
VITE_GMAPS_API="API_KEY" (for google maps search)
but more can be added later.
### install dependencies and run locally
Run the following commands
```console
npm install
npm start
```
# for production
Note: MongoDB should be installed with the sample questions as mentioned in the "for development" section above.
## to build the client
Move to the subdirectory ```client/``` and run
```console
npm run build
```
This will create a ```dist``` directory.
The entire ```dist``` directory is supposed to be copied to the production server.
## to see how the app looks
Move to the subdirectory ```client/``` and run
```console
npm run serve
```
then open [http://localhost:3000/](http://localhost:3000/) to see how the application will look in production
## for the server
## for production
Move to the subdirectory ```server/```,
The files inside the ```cgi-bin``` directory can be copied to the ```cgi-bin``` directory on the web server.
The URL in the client .env files might need to be changed accordingly.
# to add questions
- Open the ```question.html``` file directly in your web browser.
- Select a dataset from the dropdown menu.
- Click on any data point on the map, which will serve as the answer to a quiz question.
- Provide some details about the question.
- Click on the generated JSON object to copy it.
- Paste the copied text into the ```data.json``` file.
- Now, [import sample questions](#import-sample-questions-datajson-into-mongodb)