Robust RESTful API designed to serve as a bridge between our frontend applications and our backend database. Our original goal was to provide a more robust, and efficient solution to handle our frontends, with a particular focus on separating business logic from the frontend for improved maintainability and flexibility.
As we are in the process of rewriting our current frontend, Tectonic API will be our new backend. By providing a well-structured and comprehensive set of endpoints, Tectonic API allows the frontend to focus solely on displaying data and user interactions, while the backend handles the complex business logic.
-
RESTful API: Tectonic API adheres to the principles of Representational State Transfer (REST), a standard architectural style for networked applications. This makes it easy to use and understand, and allows for seamless integration with various frontend technologies.
-
Separation of Concerns: By encapsulating the business logic within the API, we ensure that the frontend remains clean and focused on user interactions. This separation of concerns improves maintainability, scalability, and flexibility.
-
Expandability: Tectonic API is designed to handle multiple frontends, making it a scalable solution for our growing projects.
git clone https://github.com/yourusername/tectonic-api.git
cd tectonic-api
docker compose up --build
Note
Only Docker is required to run the project locally.
The API provides several endpoints that can be viewed through Swagger. {baseUrl}/swagger/v1/
Tip
Our unit tests are a part of our automatic CI/CD pipeline!
I've placed a priority on learning and utilizing testing for speeding up my own development. As we move closer towards desired functionality, we hope to achieve broader test coverage. We're helped on this by this being a rewrite of an existing application, thus making the specs clear to us.
Warning
These integration tests have to be ran manually as of now.
The API has a lot of interplay and dependency on existing data. For this we have a basic Postman pipeline for running through our endpoints.
Integrations.postman_collection.json
- The project running, either locally or hosted.
- Specify a global
baseUrlvariable in Postman. For running locally through Docker:localhost:8080/api. - Specify a global
Authorizationvariable in Postman. For running locally through Docker:123.
To run this test, import it into Postman and select Run Collection.
You can find the frontend for this project at Tectonic Bot.
Currently, the project is maintained by a team of three developers. While we are not actively seeking contributions, we welcome anyone interested in contributing to review our project board and issues.