Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Bandada repository link to the API Docs #403

Closed
vplasencia opened this issue Feb 20, 2024 · 9 comments · Fixed by #405
Closed

Add Bandada repository link to the API Docs #403

vplasencia opened this issue Feb 20, 2024 · 9 comments · Fixed by #405
Assignees
Labels
feature 🚀 This is enhancing something existing or creating something new good first issue Good for newcomers

Comments

@vplasencia
Copy link
Member

Description

The idea is to add the Bandada GitHub repository link to the API Docs: https://api.bandada.pse.dev/

It would be like in the Bandada Dashboard: https://bandada.pse.dev/

It could be at the top right. Other suggestions are also appreciated.

@vplasencia vplasencia added feature 🚀 This is enhancing something existing or creating something new good first issue Good for newcomers labels Feb 20, 2024
@vplasencia vplasencia moved this to ♻️ Grooming in Bandada Board Feb 20, 2024
@intldds
Copy link
Contributor

intldds commented Feb 20, 2024

I would like to take this if possible -- top right sounds good :)

@vplasencia
Copy link
Member Author

Hey! @intldds

Sounds great! Go ahead. I just assigned you the issue. Let us know if you need help.

@intldds
Copy link
Contributor

intldds commented Feb 20, 2024

Thanks!

Actually I'm having an error everytime I run "yarn dev" or "npx nest start" inside the api folder. I think I have all dependencies installed @vplasencia

@code-Gambler
Copy link
Contributor

I think you have to run yarn dev in root directory, not inside the API folder

@vplasencia
Copy link
Member Author

Hey @intldds

These are the steps (In the root project folder):

1- Run yarn

2- Run yarn build

3- Copy the environment variable by running: cp apps/api/.env.example apps/api/.env

4- Run yarn dev

https://github.com/privacy-scaling-explorations/bandada?tab=readme-ov-file#-installation

Let us know if you still have issues.

@intldds
Copy link
Contributor

intldds commented Feb 21, 2024

Thank you both, it's working now!

I've tried adding the repository link and managed to do so; however, the DocumentBuilder class is very rigid and doesn't allow me to change the color or increase the size of the text.

The final result would be:

bandada

Outside of the DocumentBuilder class I was not able to implement it, which would've made easier to make a better UI. Let me know what you think :) @vplasencia

@vplasencia
Copy link
Member Author

Hey @intldds

Yes, it's a bit difficult. Did you take a look at the customCss and customJs or customJsStr properties?
https://docs.nestjs.com/openapi/introduction#setup-options

@intldds
Copy link
Contributor

intldds commented Feb 21, 2024

Hey @intldds

Yes, it's a bit difficult. Did you take a look at the customCss and customJs or customJsStr properties? https://docs.nestjs.com/openapi/introduction#setup-options

Great suggestion :) I've ended up following it and put the repository link and icon into customJsStr -- it looks cleaner now and easier to make changes (eg change size, color, placement, etc). Here's the PR and let me know if you need any changes!

@aguzmant103 aguzmant103 moved this from ♻️ Grooming to 🏗 In progress in Bandada Board Feb 21, 2024
@vplasencia vplasencia linked a pull request Feb 22, 2024 that will close this issue
2 tasks
vplasencia added a commit that referenced this issue Feb 22, 2024
docs: add Bandada repository link to the API docs (closes #403)
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Bandada Board Feb 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature 🚀 This is enhancing something existing or creating something new good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants
@vplasencia @intldds @code-Gambler and others