diff --git a/readme.md b/readme.md index 05011b74..a3296d81 100644 --- a/readme.md +++ b/readme.md @@ -1,27 +1,6 @@ -### Setting Up Backend +## YAUS -```shell -cd apps/api -unzip pgdata.zip -docker-compose up -d shortdb gql yaus-broker shortnr-cache -npx nx serve api -``` +### Contributing +It is recommended to develop on Gitpod since everything is coupled with a bunch of dependencies. To start your Gitpod session click on the button below. -### Setting up Frontend - -```shell -npx nx server admin -``` - -### Try It -[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Samagra-Development/yaus/tree/gitpod) - -### TODO -- [x] Migrate to Fastify -- [x] Add all the routes that are not yet implemented -- [x] Prisma Schema Setup -- [x] Posthog integration -- (Discuss and add events) -- [x] Health Check APIs (https://docs.nestjs.com/recipes/terminus) -- (Add for Db, Hasura, Redis, RabbitMq) -- [] Admin APIs -- [x] Integrate Swagger --- (Pending: Add detailed descriptions for APIs) -- [x] Added interceptor for API execution time tracking \ No newline at end of file +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Samagra-Development/yaus) \ No newline at end of file