https://github.com/readmeio/hoot
A simple social app that lets you hoot statuses. Powered by ReadMe!
https://github.com/readmeio/hoot
express expressjs nodejs openapi
Last synced: 8 months ago
JSON representation
A simple social app that lets you hoot statuses. Powered by ReadMe!
- Host: GitHub
- URL: https://github.com/readmeio/hoot
- Owner: readmeio
- License: isc
- Created: 2016-12-12T22:25:10.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2023-10-17T20:50:06.000Z (over 2 years ago)
- Last Synced: 2025-02-20T04:04:45.688Z (12 months ago)
- Topics: express, expressjs, nodejs, openapi
- Language: JavaScript
- Homepage: https://hoot.at
- Size: 1.95 MB
- Stars: 2
- Watchers: 10
- Forks: 5
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://readme.com)
# Hoot
[](https://glitch.com/edit/#!/remix/hoot)
[Hoot](https://hoot.glitch.me) 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](https://readme.com)!
### This project features all of the following ReadMe-powered tools:
- [ReadMe API Metrics](https://readme.com/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](https://docs.readme.com/guides/docs/custom-login-with-readme) 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`](https://github.com/readmeio/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`](https://github.com/readmeio/rdme) to upload the OpenAPI document to ReadMe's interactive [API Explorer](https://github.com/readmeio/api-explorer)
- See the `rdme` usage in `/bin/openapi/upload.sh`
- [`@readme/eslint-config`](https://github.com/readmeio/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](https://pugjs.org/) to render our HTML and [jQuery](https://jquery.com/) for our front-end scripts.
- On the backend, we use [Node.js](https://nodejs.org/en/) and [Express](https://expressjs.com/) to run our web server and handle all of our API routing.
- For our database, we use [MongoDB](https://www.mongodb.com/) and create an in-memory instance with [MongoDB Memory Server](https://github.com/nodkz/mongodb-memory-server). We use [Mongoose](https://mongoosejs.com/) to interact with our database.
**For setup instructions, see SETUP.md.**