petstore-backend

A test bench for an hexagonal architecture based backend.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This project is used as a baseline for other projects which share more or less the following characteristics:

• hexagonal architecture
• Postgres database
• graphql API

(back to top)

Built With

• Postgresql

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Petstore is a rust project, so you may need to have a rust development environment. Instructions on how to do that are found on the rust website.

Petstore is best run in a docker-compose environment. We use docker-compose v2.

Installation

1. Clone the repo

   git clone https://gitlab.area403.org/petstore/petstore

2. Install docker-compose v2 See docker for details
3. Run the petstore together with its database:

   docker-compose

(back to top)

Testing

1. Execute unit tests

cargo test

2. Execute integration tests Requires a backend and a database to test against. You docker-compose:

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• [] Feature 1
• [] Feature 2
• [] Feature 3
  • [] Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

Your Name - @twitter_handle - email@email_client.com

Project Link: https://github.com/github_username/repo_name

(back to top)

Acknowledgments

(back to top)