Commit 77434cdd authored by Curtis Adam's avatar Curtis Adam

Update README.md

parent eb2e63c0
......@@ -7,17 +7,20 @@ arsnova.cards uses Meteor as application framework. Download and install [Meteor
## Initial setup
1. Install [Meteor](https://www.meteor.com/)
2. Clone the remote repository `git clone git@git.thm.de:arsnova/flashcards.git`
3. Install the npm package dependencies inside the local repository **"flashcards folder"** `meteor npm install`
4. Set your initial admin user in `settings.json`
2. Make sure that you've added a [SSH key](https://git.thm.de/profile/keys)
3. Clone the remote repository `git clone git@git.thm.de:arsnova/flashcards.git`
4. Install the npm package dependencies inside the local repository **"flashcards folder"** `meteor npm install`
5. Set your initial admin user in `settings.json` or `settings_test.json`
### Settings
Change the settings in `settings.json` according to your needs
Change the settings in `settings.json` or `settings_test.json` according to your needs
> Warning: Never publish your production settings file!
> Warning: Never publish your settings file!
## Optional features
### Authentication setup (For Google, Facebook and Twitter logins)
1. [Create your Google api keys](https://console.developers.google.com/)
2. [Create your Facebook api keys](https://developers.facebook.com/)
......@@ -50,6 +53,11 @@ Use one of the following commands inside the repository (flashcards folder), to
You can then access the app from your host machine by visiting http://localhost:3000.
## Loading the Test Database
1. Make sure that you've installed [MongoDB Community Server](https://www.mongodb.com/download-center#community)
2. Use following command from the project directory (flashcards folder), **once you've started the server with the settings_test.json file**:
- `./tests/loadTestDatabase.sh`
## Contribution guide
The contribution guide can be found [here](https://git.thm.de/arsnova/flashcards/blob/staging/CONTRIBUTING.md).
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment