Bley API is a TypeScript-based REST API that utilizes TypeORM, Swagger and Zod. This API offers functionality to manage users, pets, breeds, species, vaccines, dewormers, vets, and appointments. Users can have administrator and user roles, granting them different permissions within the platform.
To run Bley API on your local environment, ensure that you have the following components installed:
- Node.js > 18
- Yarn
- Docker
Follow these steps to install and run Bley API on your machine:
- Clone this repository using
git clone
git@github.com:tamaraantonella/bley-api.git- Install dependencies
yarn- Configure environment variables. Create a .env file at the root of the project and provide the necessary values, such as database configuration and credentials.
- Run the database container
yarn test:db:up- Start the application
yarn startBelow is the entity diagram that represents the database structure used by Bley API:
You can use Bley API to perform various operations related to users, pets, breeds, species, vaccines, dewormers, vets, and appointments.
If you wish to contribute to this project, feel free to fork it and submit pull requests.