RealWorld spec and API.Pyramid codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the
This codebase was created to demonstrate a fully fledged fullstack application built with Pyramid including CRUD operations, authentication, routing, pagination, and more.
We've gone to great lengths to adhere to the Pyramid community styleguides & best practices. You are encouraged to use it as a scaffold/template for your next Pyramid project.
For more information on how this works with other frontends/backends, head over to the RealWorld repo.
How it works
Pyramid serves one of the RealWorld.io frontends (Elm) on root, so it is easier to understand how things fit together. The frontend is interchangeable, you can use any RealWorld.io frontend.
You need to have docker, pipenv and Python 3.7 installed on your machine. Docker should be running. Then you can run:
$ make install $ make start-pgsql $ make devdb $ make run
Now point your browser to:
- http://localhost:8080/ -> Conduit frontend app using the API
- http://localhost:8080/api -> Swagger documentation for the API
To run unit tests, mypy typing checker and flake8 linter:
$ make tests
To stop docker and clean container, you can run:
$ make stop-pgsql $ make clean-pgsql