Giter VIP home page Giter VIP logo

note-taking-app's Introduction

Simple note taking app

Install

run npm install

cd into /backend and /frontend

run npm install in both directories

How to use the app:

In each directory, you can:

Run: npm run start

Test: npm run dev then npm run test

These commands remain the same in either directory, /backend or /frontend:

Launch entire app with 'concurrently': npm run dev

Run backend: npm run backend

Run frontend: npm run frontend

You can optionally build the React front-end with npm run build

app includes:

  • ExpressJS backend API that uses a mock note taking database

    • localhost:8080/api
    • util/notes.js acts as a database
  • JavaScript tests with Jest testing framework

    • uses supertest to make requests
  • React frontend single page app

    • localhost:3000
    • interfaces with express backend API
    • functionality includes creating, reading, updating, and deleting of notes.
  • Selenium tests the frontend UI

    • uses selenium-webdriver
    • selenium-webdriver and jest working together
note-taking-app/
├── app-example.png
├── package-lock.json
├── package.json
├── README.md
├── /backend/
│  ├── .gitignore
│  ├── app.js
│  ├── homework-sse.md
│  ├── package-lock.json
│  ├── package.json
│  ├── README.md
│  ├── /routes/
│  │  ├── index.js
│  │  └── /notes/
│  │     ├── all-notes.js
│  │     ├── index.js
│  │     └── single-note.js
│  ├── server.js
│  ├── /test/
│  │  ├── jest.config.js
│  │  ├── jest.setup.js
│  │  └── /notes/
│  │     ├── all-notes.test.js
│  │     └── single-note.test.js
│  └── /utils/
│     ├── more-notes.js
│     └── notes.js
└── /frontend/
   ├── .gitignore
   ├── mock.png
   ├── package-lock.json
   ├── package.json
   ├── /public/
   │  ├── favicon.ico
   │  ├── index.html
   │  └── manifest.json
   ├── README.md
   └── /src/
      ├── App.css
      ├── App.js
      ├── /css/
      │  └── skeleton.css
      ├── /Display/
      │  ├── Display.css
      │  ├── Display.js
      │  ├── /FullNote/
      │  │  ├── /EditNote/
      │  │  │  ├── EditNote.css
      │  │  │  └── EditNote.js
      │  │  ├── FullNote.css
      │  │  └── FullNote.js
      │  └── /NewNote/
      │     ├── NewNote.css
      │     └── NewNote.js
      ├── index.css
      ├── index.js
      ├── /NoteSidebar/
      │  ├── NoteSidebar.css
      │  ├── NoteSidebar.js
      │  └── /NotesList/
      │     ├── NotesList.css
      │     └── NotesList.js
      ├── polyfill.js
      ├── /test/
      │  ├── /config/
      │  │  └── selenium-config.js
      │  ├── /e2e/
      │  │  ├── delete-notes.test.js
      │  │  ├── modify-notes.test.js
      │  │  ├── newnote.test.js
      │  │  └── note-taking-app.test.js
      │  └── /lib/
      │     ├── base-page.js
      │     ├── delete-notes.js
      │     ├── modify-notes.js
      │     └── newnote-page.js
      └── /utils/
         └── notes-api-helpers.js

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.