announcement-package

This is an NPM package for the Announcement model used in the backend of our project. It includes the schema definition in PRJ666/Back-End announcement-package/announcementSchema.js.

Installation

You can install this package in your project using npm or yarn:

npm install announcement-package or npm i announcement-package
# or
yarn add announcement-package

Usage

After installing the package (in the root of the front-end repo PRJ566Project), the following import of the package is made in the PRJ566Project pages/api/announcements.js.

import { Announcement } from "announcement-package";

Author

• Kierston Wong
• [email protected]

License

This package is provided under the MIT License.

Contributing

If you'd like to contribute to this package or report issues, please visit the GitHub repository.

Backend Package Creation Process

kwong in PRJ666-Back-End/announcement-package on   dev [⇣!?] is 📦 1.0.0 via ⬢ v18.18.0 
➜ npm login
npm notice Log in on https://registry.npmjs.org/
Login at:
https://www.npmjs.com/login?next=/login/cli/8e7bae3b-7b61-48c3-a022-40686222b0cb
Press ENTER to open in the browser...

Logged in on https:// registry.npmjs.org/.
npm publish
npm WARN publish npm auto-corrected some errors in your package.json when publishing.  Please run "npm pkg fix" to address these errors.
npm WARN publish errors corrected:
npm WARN publish Removed invalid "scripts"
npm notice 
npm notice 📦  [email protected]
npm notice === Tarball Contents === 
npm notice 402B announcementSchema.js
npm notice 122B index.js       
npm notice 207B package.json   
npm notice === Tarball Details === 
npm notice name:          announcement-package              
npm notice version:       1.0.0                             
npm notice filename:      announcement-package-1.0.0.tgz    
npm notice package size:  462 B                             
npm notice unpacked size: 731 B                             
npm notice shasum:        7a86359658fba0b20df8809a9e54cfdefbcbb32f
npm notice integrity:     sha512-VHwvgef8JD+aO[...]9WF5W5Rr4XXbA==
npm notice total files:   3                                 
npm notice 
npm notice Publishing to https://registry.npmjs.org/ with tag latest and default access
+ [email protected]

Frontend Package Installation Process

kwong in PRJ566Project on   dev [✘!+?] via ⬢ v18.18.0 took 40m 3.0s 
➜ npm install announcement-package

added 1 package, and audited 734 packages in 1s

144 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

Making updates to the package for future Developers

For developers: When making updates/fixes to this package run the following commands in order to publish a new version of the package.

npm version patch
npm publish