This api give Greenstand the ability to like
anything, for example: like a tree, like a grower.
This repository was created from Greenstand's template for microservice projects. This means it comes with many development tools that we use for development and deployment. As a contributor to this repository, you should learn and use these tools. They are outlined below.
- NestJS
- Yarn
- Prisma
- Conventional Commits
- husky
- prettier / lint
- GitHub actions
- Jest
- TypeScript
Please join our slack channel to get help with setting up the database.
The TreeTracker Like System is Greenstand's new experiment using a monorepo structure. A monorepo is a single repository containing multiple distinct projects with well-defined relationships.
In the Like System, both the backend and frontend implementations are located in the apps
folder. The backend is built on the NestJS framework. Shared resources for the backend and frontend are placed in the libs
folder. Shared resources include objects, utilities, constants, etc.
The database design for the backend like project could be find here.
We are using Prisma to implement our database and the DBMS is Postgres.
In Greenstand, we value test driven development.
To run the unit tests:
npm run test-unit
All the integration tests are located under folder __tests__
To run the integration test:
Run tests:
npm run test-integration
to build the image run
docker-compose build
to run the image background run
docker-compose up -d
after the image runs up in the background , u need to then define a DATABASE_URL
in the env
the format of the DATABASE_URL
has to be like this
postgresql://username:password@host:port/database
e.g DATABASE_URL=postgresql://easyuser:easypassword@localhost:5432/treetracker-like