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

Updates in readme documentation #744

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 26 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,26 @@
# Vachan-api

The server application that provides REST APIs to interact with the underlying Databases (SQL and Graph) and modules in Vachan-Engine.
<h1 align="center">
<br>
<a href="http://www.amitmerchant.com/electron-markdownify"><img src="https://api.vachanengine.org/static/images/Logo.svg" alt="vachanapi" width="200"></a>
<br>
Vachan API
<br>
</h1>
<h4 align="center">Unified API for <a href="https://api.vachanengine.org/" target="_blank">Vachan-Engine applications</a></h4>
<p align="center">
•<a href="#implementation-details"> Implementation Details</a> •
<a href="#start-app-with-docker">Start App</a> •
<a href="#set-up-locally-for-development-and-testingwithout-docker">Setup</a> •
<a href="#license">License</a>
</p>

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Markdown format is often used for its simplicity. I thinks its better to stick to it and avoid embedded HTML as much as possible.
In these we can use markdown features to get decent level of formatting

# big heading
## small heading
### smaller heading
[link-text](link-target)
- list item1
- list item2
   - sub item1
   - sub item2

big heading

small heading

smaller heading

link-text

  • list item1
  • list item2
    • sub item1
    • sub item2

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kavitharaju Markdown doesn't directly provide the option to align text and resize images. HTML is used for this purpose.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How critical is aligning text in a readme?
About image resizing, yes you could use it places where markdown support is not there. But keep it limited to that

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another thing is I am reviewing this PR with little context. The parent issue says

Enhance the Readme file of Vachan API by providing comprehensive and clear documentation.

Which in my opinion doesn't say anything! What are we making more comprehensive and clear here? The issue itself should be more specific and to the point than a too generalized statement like this.

And honestly I doubt the changes in the PR is making anything more comprehensive and clear.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something I liked here is the idea of adding a gif. Makes the document more interesting. But is the API docs the best thing we can show in it? May be... I dont know..

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How critical is aligning text in a readme? About image resizing, yes you could use it places where markdown support is not there. But keep it limited to that

Text alignment is required only at the single line description("Unified API for VE applications") and the direct links mentioned below that line.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it really have to be center? Why?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to keep it properly down to the logo(which is kept in middle)

Copy link
Author

@shimilgithub shimilgithub Nov 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another thing is I am reviewing this PR with little context. The parent issue says

Enhance the Readme file of Vachan API by providing comprehensive and clear documentation.

Which in my opinion doesn't say anything! What are we making more comprehensive and clear here? The issue itself should be more specific and to the point than a too generalized statement like this.

And honestly I doubt the changes in the PR is making anything more comprehensive and clear.

will modify issue description

Currently serving 3 client applications, VachanOnline website, the Vachan Mobile App and AutographaMT Bible translation tool.

Joel-Joseph-George marked this conversation as resolved.
Show resolved Hide resolved
![screenshot](https://github.com/shimilgithub/vachan-api/blob/de41c3fcc1149a025adcd93ff108a3d786d78818/app/static/images/api_screenshot.gif)


The Vachan API is a robust server application designed to facilitate seamless interaction with the underlying Database and various modules within the Vachan-Engine ecosystem. This versatile API is essential for a wide array of client applications, including the Vachan Online website, Vachan Admin, Vachan Mobile App, IntelliSign - the Smart Sign Language Translation Platform, and the AutographaMT Bible translation tool.

It achieves this by offering both REST APIs, catering to traditional database interactions, and utilizing Strawberry GraphQL for enhanced flexibility and efficiency.

## Implementation Details

Expand Down Expand Up @@ -93,8 +111,9 @@ Edit the following contents appropriatetly and paste to the `.bashrc` file
export VACHAN_LOGGING_LEVEL="WARNING"
export VACHAN_KRATOS_ADMIN_URL="http://127.0.0.1:4434/"
export VACHAN_KRATOS_PUBLIC_URL="http://127.0.0.1:4433/"
export VACHAN_SUPER_USERNAME="<super-admin-emial-id>"
export VACHAN_SUPER_USERNAME="<super-admin-email-id>"
export VACHAN_SUPER_PASSWORD="<a-strong-password>"
export VACHAN_DOMAIN=127.0.0.1:8000
```
After editing .bashrc file they may need to run

Expand Down Expand Up @@ -155,3 +174,6 @@ To run all the testcases, from the folder vachan-api/app run the command
```python -m pytest```

For runing testselectively, refer [pytest docs](https://docs.pytest.org/en/stable/usage.html#specifying-tests-selecting-tests)

## License
Bridge Connectivity Solutions Pvt. Ltd.
Binary file added app/static/images/api_screenshot.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading