TagmeModels

This project centers the mongoose models used by Tagme Node.js projects and is a npm private package.

Usage

1. Make sure the project has the tagmedev npm login token file .npmrc inside the project root folder (i.e. the package.json containing folder);
2. Include and install the @tagmedev/tagme-models module as a project dependency (e.g. npm install @tagmedev/tagme-models --save);
3. Require the package on the script files as require('@tagmedev/tagme-models').

• E.g. var AppsModel = require('@tagmedev/tagme-models').Apps;

Updating

1. Clone this GitHub repository;
2. Update the code as needed and push all your modifications;
3. When you're ready to publish the new version, run npm version <patch|minor|major> -m '<message>'

• Use patch when you made backwards-compatible bug fixes;
• Use minor when you added functionality in a backwards-compatible manner;
• Use major when you make backwards-incompatible changes;
  • On a branch other than master, you may also use prepatch, preminor or premajor to test new features;
• Write a summary message for this new version;
• Depending on the update type, npm will increase one of the version parts inside package.json respecting major.minor.patch, create a new commit and also tag this release.

4. Push everything, including the tags: git push origin <branch name> --tags;
5. Run npm publish.

Creating a new package

1. Create a new GitHub repository and clone it;
2. Copy the npm login token file .npmrc to the project root folder;
3. Run npm init and follow the steps;
4. Code the project as needed:

• Suggestion: use an index.js file to export all modules coded inside a lib folder.

5. Commit and tag this release, e.g.:

• git add -A
• git commit -m 'Initial release';
• git tag v0.0.1;
• git push origin <branch name> --tags.

6. Run npm publish.