Create the backend database and rest api

Reference no: EM132686218

CSE5WDC Web Development On The Cloud - La Trobe University

Assignment

You have been hired by a client to develop a new web service, "Neverwrote", for managing virtual notes - "Never say 'I never wrote that down' ever again!". Having heard of the latest and greatest in web technologies, your client specifies that the backend shall run on a Node.js server, and that the frontend shall be built with React. "That's strange, those are exactly the same things that I learnt in CSE5WDC" you think to yourself as you boot up your computer and get ready to start work.

Objectives
• To combine what you've learnt in labs into a complete web application
• To provide you with a reference web application for future projects

Part 1 - Backend API

Task 1.1
Create the backend database and REST API for the Neverwrote application.

Specifications
The database shall have two tables, one for notebooks called Notebooks and one for notes called

Notes.
• Records from the Notebooks table shall contain the attribute title (string).
• Records from the Notes table shall contain the attributes title (string) and content (text).
• All tables have a primary key column called id.
• Foreign keys shall follow the camel-case naming convention (eg a foreign key to the Notebooks table would be called notebookId). Specify the foreign key name explicitly in associations, as in Lab 07 (there we did foreignKey: 'postId').
• Each note shall belong to one notebook, but a single notebook can have many notes.
• Two Sequelize models shall be defined - Notebook and Note. These models shall have the correct associations.
• The backend shall expose the following REST API:

• The tests shall pass. This is a very helpful tool, as you can verify that you are on track as you complete this part of the assignment. You can run the tests with:
docker-compose run --rm api jasmine

? You shall not modify the tests in the spec/ directory
• The API shall access the database (and accept values from the HTTP request where appropriate). The REST API shall not use hard-coded values for notes or notebooks.

Part 2 - Frontend interface
You will find "Lab 08 - Frontend" to be particularly useful as a reference for this part. I have also prepared a stripped-back React/Redux code example which you may find useful to look at for ideas:

Task 2.1
Create a read-only web interface for the Neverwrote application which displays notebooks and notes.

Specifications
• There shall be a view which lists the titles of all of the notebooks.
• Clicking on a notebook shall display a list of all of the titles of notes within that notebook.
• Clicking on a note shall show the full content of that note.

Task 2.2
Allow users to create and delete notes and notebooks via the web interface.

Specifications
• Users shall be able to create and delete notes and notebooks.
• The state of the application shall be maintained in a Redux store.
• All changes to the Redux store shall be made via dispatched actions.
• Modifications to notebooks and notes shall be persisted in the backend database via the REST API. Therefore changes should survive a page refresh.
• You shall use the MarkdownEditor component provided for you as the way to edit notes. This is not much different from using a normal text field. Example usage: <MarkdownEditor value={this.state.noteContent} onChange={onChangeContent} />
• You shall use two Redux reducers: one for the notebooks and one for the notes.

Task 2.3
Make the interface pretty and nice to use. The Internet is a great place to find inspiration for styles and small snippets of CSS which you can incorporate into your design.

Bootstrap v3.3.6 is already included as a dependency of the project, and defines a bunch of nice- looking CSS classes which you can use out-of-the-box.

Part 3 - Summary statistics Task 3.1
Create a new controller in the backend and set up the routes so that the controller is responsible for the /stats URL path. Add a single action to the controller which responds with JSON indicating some key statistics about the notebooks and notes stored in the database. Use your Sequelize models to perform the necessary database queries.

Specifications
• The new /stats API endpoint shall be made.
• The stats controller code shall be placed in a new file, src/controllers/stats.js.
• The /stats endpoint shall respond to GET requests with a JSON object containing the following information:
• The number of notebooks in the database.
• The number of notes in the database.
• The name of the most recently updated note.
• The name of the oldest notebook by creation time.

Task 3.2
Modify the frontend to display summary statistics on the Neverwrote home page. The statistics themselves shall be retrieved using the /stats API endpoint implemented in Task 3.1.

Specifications
• A new reducer shall be added for managing statistics in the frontend application store.
• A new "Statistics" React component shall be created which is connected to the application store and displays the summary statistics.
• The Statistics component shall be displayed on the Neverwrote home page.
• Stats shall be loaded into the application store the first time that the Statistics component is initialised.
? It is not required that the statistics update as notes/notebooks are added, removed, or modified.

Task 3.3
Add a refresh button which updates the displayed statistics when clicked.
For example, if the statistics show a count of 3 notebooks, and then you add another one, clicking the refresh button should update the displayed statistics to indicate that there are now 4 notebooks.

Specifications
• A refresh button shall be visible in the statistics component.
• Clicking the refresh button shall update the stats by accessing the /stats API endpoint.

Part 3 - Bonus task

These bonus tasks are an opportunity for you to earn back marks which you may lose in the other parts of the assignment.
Implement a search system for the frontend interface.
• 10 marks will be awarded for search functionality within a notebook (filtering based on title and content). This can be purely client-side (in the browser).
• The rest of the marks will be awarded for a separate ability to search across all notes and notebooks based on title and content. This shall be implemented via a new API endpoint (so the searching happens in the backend).

Attachment:- Web Development On The Cloud.rar

Reference no: EM132686218

Questions Cloud

The value of a quality assurance department : The role health insurance plays in cost, quality, and healthcare consumer expectations. The role that national policy plays on the quality of healthcare.

Explain in depth the correlation between the persons ph : Explain in depth the correlation between the person's pH and why their respiratory muscles are breaking down. Provide details in your explanation and support.

?what are the different tiers of corporate-level strategy : ?What are the different tiers of corporate-level strategy? What is the purpose of corporate-level strategy?

List some common misconceptions about cam : List some common misconceptions about CAM. Identify methods of including the use of CAM in patient education. Discuss the safe use of CAM.

Create the backend database and rest api : Create the backend database and REST API for the Neverwrote application - Create a read-only web interface for the Neverwrote application which displays

Influence the development of health care policy : How do cost analysis studies influence the development of health care policy? Do the most cost-effective practices always get adopted into law?

Support the strategic goals of the organisation : The purpose of work is to achieve specific objectives and goals and to support the strategic goals of the organisation.

Which of the represents prime costs : Direct materials, direct labor, and factory overhead represent which of the following cost? Which of the following represents prime costs?

Current simplified depreciation rules : Go to the ATO website and source the information for the current simplified depreciation rules which apply?

User Account

All Pages