Notes: a simple page to store your notes

Description

"Notes" is a simple page where you can store, recall, update and delete notes. This is a simple project I made while on placement at DWP to learn some foundational skills in software engineering.

Technologies used within this project:

• Express : Web framework for node js
• SuperTest : Used to HTTP/integrating testing
• MongoDB : A database used to store our data/notes

Key skills demonstrated :

• Writing a backend and frontend service using Javascript
• Creating a interactive page with HTML and CSS
• Writing integration tests with SuperTest
• Creating a local server using Express to "talk to" our database
• Setting up and using a database using MongoDB
• Applying HTTP methods
• Writing an affective readme page and a open api document

---

Installing and Setup

Locally

Important

Before setting up locally, you will need a Mongo account.

1. First, clone this repository into your local directory. There are many ways of doing this, most of which can be found in "<Code>" on Github when you view the repository under the "<> Code" tab.

   To install using git, run the following command into you command prompt when you are in your desired directory.

   git clone https://github.com/JanOnBread/Notes.git

2. Add your MongoDB server Locate the file "note-service.js" and, near the top, replace 'dataBaseLoc' with the url of your MongoDB. It should look like the following with your own url.

   const dataBaseLoc =
     "mongodb+srv://<username>:<password>@<host>/?retryWrites=true&w=majority";

3. Running the code Finally run the commnand,

   npm run notes.js

   and the page should run locally on http://localhost:3002.Terminate running code from the console to stop the local server.

Externally

This is currently not available.

---

Usage

Posting or updating a note

At the top, first choose wether you want to POST or PATCH a note.

• Posting: Adding a new note into our database
• Patching: Updating a note within our database based on a id

In the text box below, write down your note or what you want a note to be updated to be. Press submit to then this will send a POST or PATCH request Please look within the "log from server" box to see if note posting/patching was successful. If the textbox is empty then a note won't be posted/patched even when hitting submit. A message in the "server long" box should display this error.

Note

When posting, an Id and date is automatic assigned. The Id will be randomly generated based on (max ID in database) + 1. This can mean that come some id's won't be assigned to a note. For example, if there are 3 notes in our database (0,1,2) if we delete note 1 and then create a new note, the new note will be assigned a ID of 3 so we will have notes with ID (0,2,3).

Finding a note

In the "Find a note" section, use the choose the note you want to retrieve based on it's id. The box should automatically update every time you change number.

Deleting a note

You can first choose to delete a note by ID or to delete all notes

• By all: Delete all notes within our database. A pop up message will appear confirming you want to choose this option as this can't be undone.
• By id: Delete a note based on it's id

Log from server box

This box displays messages from the server, it will display something every time an action has been taken. It's suggested that you often check this boxes to confirm an action has been taken or an error message on why it has not.

---

Testing

You can test the code using notes.integration.test.js(using SuperTest) and/or openapi.yaml(using open API). It's recommend to use Open API for testing as it is more visual.

• With Open API: When the server is running, go to `http://localhost:3002/openapi'.
• With SuperTest: In your command prompt , type the following jest notes.integration.test.js