Giter Club home page Giter Club logo

react-hooks-evernote-json-server-guided-project's Introduction

Phase 2 Guided Project Guidelines

In this guided project, we'll be building an Evernote-like application with React.

Your goal will be to complete the baseline deliverables using the provided starter code and then make this project your own by building out unique stretch goals. Some suggestions are listed below, but try to be creative!

Requirements

  • Complete all of the deliverables
  • Build out at least 1 stretch goal feature

Setup

To get started, fork and clone this repository.

The codebase is split up into a JSON Server API backend and a React frontend.

Frontend

To setup and run your frontend:

$ npm install
$ npm start

This React app will be running on http://localhost:4000.

Backend

First, set up your database by running:

$ npm run seed

This will seed some starter data for you in the db/db.json file. Any time you want to reset your database to its original state, just run npm run seed again to overwrite your data with some fresh seed data.

To run json-server, run:

$ npm run server

Your backend API will be running on http://localhost:3000.

User ID

The seed file should create one user for you, so your default userId should be 1. You can check the db/db.json file to make sure.

Routes

Method Route Headers Body
GET /users
GET /notes
POST /notes 'Content-Type': 'application/json';'Accept': 'application/json' title, body, userId
PATCH /notes/:id 'Content-Type': 'application/json';'Accept': 'application/json' title, body, userId

Tips:

  • Test out your routes with Postman to see how they work and what they return.

Provided Code

  • All CSS styles are provided for you.
  • Many components are provided for you, but most are not completely functional. It is your job to read the code and figure out how to incorporate it into your app.

Deliverables

Look at the gif below to see how the app should look and behave. These are the baseline deliverables you need to complete:

Viewing and Displaying Notes

  • Display all notes in the left sidebar.
  • Displayed sidebar notes should show the title and a truncated body.
  • When a note from the sidebar is clicked, display its contents in the right panel.

completed display notes

Filtering Notes

  • Implement the filter to search through your notes list by title.

completed filter notes

Creating Notes

  • At the bottom of your left sidebar, show a New button.
  • Clicking New will create a new note via a POST request with some default title and body. NOTE: You don't have to use any kind of <form> element for this deliverable; you can create an object with a default title and body text when the button is clicked. Make sure to check the Routes section of this README to determine what data you need in the body of your request.
  • This new note should appear in the sidebar.

completed create notes

Editing Notes

  • When displaying a note in the right panel, show an Edit button.
  • Clicking the Edit button will allow the user to edit the title and body in the right panel.
  • When in edit mode, also show a Save button which saves the note via a PATCH request.
  • When in edit mode, also show a Cancel button which discards any changes and reverts back to displaying the note.
  • Clicking a different note while in edit mode should discard your changes and display the new note instead.

completed edit notes

Stretch Goals

When you are finished with the deliverables, you can build out any new features that you want. This is your chance to be creative and make your project unique!

Some suggestions:

  • Add the ability to filter by body, date created, date edited, etc.
  • Sorting by date created, date edited, alphabetical, etc.
  • Use react-router to create a multi-page app
  • User signup & login
  • Sharing notes with other users
  • Rich text formatting
  • Tagging
  • Emailing notes

react-hooks-evernote-json-server-guided-project's People

Contributors

dependabot[bot] avatar lizbur10 avatar ihollander avatar rrcobb avatar hysan avatar shivangdave1 avatar calamityadam avatar danielezils avatar graciemcguire avatar jlboba avatar notnotdrew avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.