https://github.com/yeah568/trove
https://github.com/yeah568/trove
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/yeah568/trove
- Owner: yeah568
- Created: 2015-05-08T17:00:38.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2015-09-03T18:22:07.000Z (almost 11 years ago)
- Last Synced: 2025-01-23T07:13:27.612Z (over 1 year ago)
- Language: JavaScript
- Size: 56.7 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Trove
## Setup
* Run ```npm install```
* Ensure a MongoDB database is available for use. Either install MongoDB on the server locally, or use a hosted services such as [Compose](https://compose.io) or [MongoLab](https://mongolab.com/).
* Supply the MongoDB URI in the config/config.js file, under the appropriate environment. Make sure your environment variables are set up to the right one. While the config file already contains a sample database, it is _strongly_ recommended that you do not use this for production, as the credentials have been on a public repo.
* Change the port to whatever is needed - either port 80 if it is the only thing running on this server, or another port, and use something like Nginx reverse proxying to route traffic to this.
* Ensure config/admin.htpasswd exists. The username/password in this file is used to log in to the admin panel.
* Use ```npm start``` to start the app. Something like [forever](https://www.npmjs.com/package/forever) will help ensure it's always up.
__Note__: While this will run and compile on Heroku, image uploads will __NOT__ work. This is due to a limitation with Heroku having read-only settings for their dynos, and would require a separate image host.
## Usage
### Add a User
* Navigate to /admin
* Create a new user with either a custom name, or click "Generate a User ID" to have one randomly generated. Click "Add" to save it.
* Give this user ID to the participant, along with a link to the main site.
* The user then enters this ID into the login box, and begins.
### Add a Round
* Login to the admin panel, and use the dropdown under the "Rounds" panel, labelled "Add a round". Fill in the fields and click save.
* To delete a round, click the red trash can next to the round you wish to delete.
* Ensure that there are no gaps in the round numbering, and that round numbers start at 1.
### Change Completion Screen or Consent Screen Text
* Login to the admin panel, and use the "Consent/Completion Screen Text" panel to change the text shown on these screens.
### Change Admin Password
* The default admin account has the username "admin" and the password "admin".
* To change this, navigate to the admin panel, and scroll to the bottom panel titled "Admin Account". Enter a new username or password, and click save.
* Login again to be able to access the admin panel.
* There is only one admin account in this system.