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.

Sign up for GitHub

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

Jump to bottom

docs: add instructions to create the git submodule to README #375

Merged
merged 2 commits into from
Jun 21, 2024
Merged

docs: add instructions to create the git submodule to README #375

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5621516
docs: add instructions to create the git submodule to README
JustARatherRidiculouslyLongUsername Jun 20, 2024
f37f5a9
Merge branch 'master' into docs
JustARatherRidiculouslyLongUsername Jun 21, 2024
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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ Django Rest Framework API for Fyle Xero Integration

### Setup
Copy link

Choose a reason for hiding this comment

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

Consider changing the heading level from h3 to h2 for "Setup" to maintain a proper semantic structure in the document.

- ### Setup
+ ## Setup
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### Setup
## Setup
Tools
Markdownlint

4-4: Expected: h2; Actual: h3 (MD001, heading-increment)
Heading levels should only increment by one level at a time


* Add and update the `fyle_integrations_imports` submodule
```bash
Copy link

Choose a reason for hiding this comment

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

Ensure that all fenced code blocks are surrounded by blank lines and specify the language for clarity and proper formatting.

* Add and update the `fyle_integrations_imports` submodule

+    ```bash
     $ git submodule init
     $ git submodule update
+    ```

* Rename docker-compose.yml.template to docker-compose.yml

+    ```bash
     $ mv docker-compose.yml.template docker-compose.yml
+    ```

* The database can be accessed by this command, on password prompt type `postgres`

+    ```bash
     docker-compose run db psql -h db -U postgres xero_db
+    ```

* To tail the logs a service you can do

+    ```bash
     docker-compose logs -f <api / qcluster>
+    ```

* To run bash inside any container for purpose of debugging do

+    ```bash
     docker-compose exec api /bin/bash
+    ```

Also applies to: 18-18, 45-45, 51-51, 57-57, 63-63, 69-69, 75-75, 81-81

Tools
Markdownlint

7-7: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines

$ git submodule init
$ git submodule update
```

* Download and install Docker desktop for Mac from [here.](https://www.docker.com/products/docker-desktop)

* If you're using a linux machine, please download docker according to the distrubution you're on.
Expand Down
Loading