Chingu Solo Project - Tier 3 - Journal App

Overview

This project helps you gain experience using authentication techniques to protect your app and users against unauthorized access. Your objective in this project is to build a web application that allows users to register, login, and maintain personal notes.

About Chingu

If you aren’t yet a member of Chingu we invite you to join us. We help our members transform what they’ve learned in courses & tutorials into the practical experience employers need and want.

Our remote team projects let you refine your technical skills and put them into practice while gaining new “soft” skills like communication, collaboration, and Agile project management. The types of skills that help real-world teams get things done!

You can learn more and join us at chingu.io.

Instructions

General instructions for all Solo Projects are located in the Chingu Library. For detailed requirements, please checkout the following.

You may use vanilla JS/HTML/CSS or the framework of your choice. Since the Solo Project must be completed before you start your Voyage Project we suggest you use what you are already familiar with. Your focus should be on completing the Solo Project so you can advance to the Voyage Project.

Requirements

Structure

• Backend: Design & create your backend application server
  • Set up your backend boilerplate (e.g. database URI)
  • Create the note schema
  • Create the backend routes (e.g. GET, POST)
• Frontend: Identify and create the main components of your frontend application (e.g. Header, Note input area, list of previously entered notes, dialog or area to update previously entered notes)

Style

• You may use any style you choose. However, it should be consistent (e.g. font, font size, color scheme, layout, etc.).
  • See Consistent Web Design
  • See Why is consistency important in Web Design?

Functionality

• Backend: Implement user authentication
  • Add a signup route to allow users to create an app account (e.g. user name & password) for themselves
  • Add a login route to allow users who have completed the signup process to login to the application
• Frontend: Implement the necessary functionality for each component. Users must be able to:
  • signup to create an app-specific account
  • login to use the app
  • post a new notes to the list of previously entered notes
  • modify previously added notes
  • delete previously entered notes
• Frontend: Miscellaneous functionality
  • Use the API exposed by the app Backend to deliver functionality to your users
  • Frontend: Application secrets and user credentials should not be stored or left exposed in the browser

Other

• Your repo needs to have a robust README.md (See Keys to a Well-Written Readme)
• Before submitting make sure that there are no errors in the developer console
• Anticipate and handle any edge cases
  • Does entering random data, such as a mix of alphbetic, numeric, and special characters in the search input result in an error?
  • What is displayed if the search location is not found?
• The app should be responsive across multiple devices (e.g. phone, tablet, laptop, and desktop computers)

Extras (Not Required)

• Add the ability for users to upload pictures (or even audio clips) to notes
• Allow notes to be formatting using Markdown
• Use as FEW external packages and libraries as possible to reduce the number of dependencies.
• Include tests cases using tools like Jest, Enzyme, etc.
• Use Accessibility techniques (i.e. a11ly) to improve your site for users with impairments (see A11Y Project)
• Add a CONTRIBUTING.md file with instructions on how to contribute to your project
• Implement service workers to improve performance by relying on cached data (see Service Workers: An Introduction)