Skip to content

Home

Jump to bottom
Rafael J. Rodriguez edited this page Apr 20, 2017 · 1 revision

Author

@Rafase282

Created by Rafase282

Github | FreeCodeCamp | CodePen | LinkedIn | Portfolio | E-Mail

Gitter Build Status Dependency Status devDependency Status bitHound Overall Score bitHound Dependencies bitHound Dev Dependencies bitHound Code Code Climate Issue Count

MangaDB Microservice

This is an API created to store crucial information for any manga an authenticated user might read. Wether you want to keep track of the manga you will read, already finished or are currently reading, this microservice will help you get your data together.

In the Future I intend on adding more features but meanwhile the user interface will be separated and this stays as the core backend.

There is an admin account that is declared on the envarioment variables that basically has full access, it must be created and a secure password used. The admin can override any information if needed including passwords. In the future I will implement email services to mail queries, and particularly to allow for password reset if forgotten.

Setup:

To get started just follow these steps.

  1. git clone https://github.com/Rafase282/Mangadb.git
  2. cd Mangadb && npm install
  3. Open a new console to run mongo. sudo service mongod start for Ubuntu users.
  4. Still on the same directory, find default-env and rename it to .env.
  5. Fill in the variables from the file with the data you want.

Lint, Test, Run:

  • If you want to lint just run npm run lint.
  • If you want test and ensure everythign works, then npm run test.
    It will test all routes. The test are independent of eachother.
  • To run the application use npm start.

Documentation and links:

Contributing:

If you want to contribute to the project, feel free to pick any of the open issues and work on them in a new branch and submit a pull request.

Support:

If you have any questions not related to any of the open issues, then you can reach me in my Gitter or via any of my public contact information.

If you like the project, please start it to receive updates and help make it more noticeable.

If you would like to help out with financial support, you are welcome to do so via paypal.me/rafase282.

I'm currently looking to get my career started so any amount helps. If you would like to hire me for a position or work on a project then you may also contact me about that.

Clone this wiki locally