Compta

Install and start

MongoDB

Just install a mongo database, following this link :

mongo documentation

Start Server

  cd server
  npm i
  nodemon index.js

Start App

  cd app
  npm i
  npm run dev

Contribution

• Api documentation is on :

  your_absolute_project_path + /apidoc/index.html
  

  Example :

  file:///C:/wamp64/www/Compta/apidoc/index.html
  

• Test your code and lint

    npm run lint

• If you have modified the api think to regenere doc

  apidoc -i server/ -f "server.js" -o apidoc/
  

• If necessary change version

    git tag -a [version]

• Push

    Push origin dev --tags

TO-DO

• add resource
• list resource
• edition resource
• delete resource
• hash password