HTTProfile is a side project of TEECOM's research and development group, TEECOMlabs. We started work on HTTProfile in December of 2019, heavily inspired by the awesome httpstat.
This frontend site was built using a language we love, Elm. It was styled with Tailwind, complimented by Steve Schoger's beautifully design icon set, Zondicons, and visually inspired by Derrick Reimer's StaticKit. The backing API was written in Go, guided by Dave Cheney's implementation of httpstat.
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to tommy.schaefer@teecom.com.
The frontend codebase is written in Elm, and depends on a handful of JavaScript libraries. These libraries are managed by yarn, and can be installed by running the following from the project's root directory:
yarn install
There are some additional Elm packages you'll want to load too:
npx elm install
To run the frontend locally, run the following from the project's root directory:
yarn dev
This will start an auto-reloading server for the Elm frontend.
You can run tests by executing the following from the project's root directory:
yarn test
The backend codebase is written in Go, and uses Go modules. To run the backend locally, run the following from the root project directory:
go run httprofile/src/backend
This will start up an API server on port 8080. To run the server on a
different port, run:
PORT={custom port} go run httprofle/src/backend
instead.
For more information on the API endpoints, check out the API documentation.
For information on how to contribute to this project, check out the contributing guidelines.
HTTProfile is deployed automatically when code is merged into the production
branch. Frontend code is deployed to Netlify, while backend code is deployed
to Heroku.
If you have any questions about HTTProfile, or if any of the documentation is unclear, please feel free to reach out through a new issue.
😺