README.md

Hoot

Hoot is a simple social app that lets you hoot statuses. More importantly, it has a simple REST API written in Node and Express which you can connect to ReadMe!

This project features all of the following ReadMe-powered tools:

• ReadMe API Metrics, which allows users to see their API logs within the API documentation and project administrators to view insights based on API usage
  • See this example in /middleware/metrics.js
• ReadMe Custom Login to log users into the API documentation, which allows them to interact with the Hoot API using their Hoot login credentials
  • See this example in /middleware/jwt.js
• swagger-inline to generate a full OpenAPI document using in-line comments from the code in the /api directory
  • See the swagger-inline usage in /bin/openapi/generate.sh
• rdme to upload the OpenAPI document to ReadMe's interactive API Explorer
  • See the rdme usage in /bin/openapi/upload.sh
• @readme/eslint-config, which ensures that this codebase conforms to ReadMe's core coding standards
  • Run npm test to lint the codebase

Other common tools used:

• On the frontend, we use Pug templates to render our HTML and jQuery for our front-end scripts.
• On the backend, we use Node.js and Express to run our web server and handle all of our API routing.
• For our database, we use MongoDB and create an in-memory instance with MongoDB Memory Server. We use Mongoose to interact with our database.

For setup instructions, see SETUP.md.