Our team can be seen here: Group 7
MyJournal is a personalalized social media app where the users can post for themselves. The purpose of MyJournal is to allow users to truly express themselves without having to worry about what others think. MyJournal is just like a social media where a user can post how they're feeling and any text; the difference is that there are no friends, no seeing each other's posts, and the user's posts are only visible to themselves.
To make MyJournal more personalized users create their own posts which each have an emotion associated with them. The user is then able to view just posts from a certain emotion or all posts at once. The user can also view posts from a certain date.
Key Features of our website include:
- Creating Posts
- Editing Posts
- Deleting Posts
- Filtering Posts by Label Assigned
- Filtering Posts by Date Created
MyJournal can be viewed and used here: MyJournal
Documentation can be viewed and used here: JSDcos
Make sure when working on a new feature for the project you pull from the main branch so that you have all of the up to date source code, and save your new work in a new branch for the feature or bug fix.
The CICD Pipeline for this project relies on several tools which can be downloaded through Node
First Install Node from NodeJS.org then run the command below inside of your working directory
npm install
Rita has included a couple scripts in the package.json file to help you lint your code before submitting.
npm run eslint-fix
npm run prettier-fix
Any HTML and CSS code should also be validated before submitting
npx html-validate --ext html ./source
And the JSDoc should be built from any updated javascript. Currently, we have a workflow that generated JSDocs and puts it into a branch called docs each time there is a merge to the main branch. This branch then has to manually be merged into main with a pull request from a developer. In the future, we would also automate the merging of the docs branch into main. However for now, the pull request and merging to main must be done manually.
npx jsdoc -r ./source -d ./docs
Finally any test cases should be checked
npm run test
This should run both unit tests as well as end-to-end tests that are created.
Create a pull request to merge your branch back into main and request a review from someone else on the team. If the reviewer approves and the github action passes all the tests you are good to merge and delete!