Giter VIP home page Giter VIP logo

noteful-app's Introduction

Noteful: A note taking app

This app is meant to give students experience with building REST APIs with Node, Express, JWT-based auth, Mongo, and Mongoose.

It is also provided as a backend that curriculum contributors, instructors, and students can run locally to build clients that provide a GUI for this API.

Full API spec available here

Seed db and run server

  1. Clone the repo.
  2. cd into it.
  3. npm install
  4. Make sure you have Mongo installed and running locally.
  5. Rename the .env.example file to .env. This file sets up any config vars that you'll need to run this app locally.
  6. Run node utils/seed-database.js
  7. The seed process inserts four users: patuser, bobuser, janeuser, and anonuser with the password password.
  8. Run npm start to start the dev server.
  9. To access a protected endpoint
    1. POST the username + password to /api/login
    2. Copy the authToken value
    3. Add token Authorization header as a Bearer Token

If you need to zero out the database, you can run node script/dropDatabase.js

noteful-app's People

Contributors

cklanac avatar tsongas avatar benjaminewhite avatar sarajo avatar

Watchers

James Cloos 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.