Skip to content

Latest commit

 

History

History
41 lines (32 loc) · 2.14 KB

README.md

File metadata and controls

41 lines (32 loc) · 2.14 KB
Raw

FlashcardX

Node.js REST API for the flashcard based learning platform: FlashcardX

Requirements:

    Unix based system(Linux or OSX)
NODE v7+
MongoDB V3
REDIS V4

For running the project:

  1. clone the project and standing on the /api directory run: sudo npm install
  2. create a folder called: "flashcardx-keys" in your $HOME directory (run $HOME in the console to know where it is pointing to)
  3. inside the "flashcardx-keys folder" you gotta drop the keys for the cloud services, write us to: "contact@flashcardx.co" and we will send you those keys
  4. start the databases: mongo with sudo mongod and redis with redis-server
  5. Create the user for mongodb with the commands:
      a) Open the mongo console by running: mongo
      b) Run db.createUser({user:"pablo", pwd:"1234", roles:[{role:"root", db:"admin"}]})
  6. in /api dir run the project with node app.js

Contributing

We'd greatly appreciate any contribution you make :). Please check out our milestones here we have all the future goals for the project, you can pick any issue that's not taken by somebody and assign it to yourself, or if you have new ideas create a new issue in the nice to have milestone For contributing create a branch with the name of the feature you are working on(please follow the current code style of the project and make tests(in the /tests folder) for everything before pushing it), then when you are ready make a pull request to master.

Slack group

Send us an email(contact@flashcardx.co) requesting an invitation for our Slack group Here we discuss new ideas about the future of the platform!

Documentation

https://api.flashcardx.co/apidoc

License

This project is licensed under the terms of the MIT license. With the exception of the trademark and logos(flashcardx) wich are property of Pablo Nicolas Marino