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

chore: Update README to correct services links; markdown lint fixes #301

Merged
Show file tree
Hide file tree
Changes from all 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
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,32 +68,32 @@ Each Gateway services is an independent microservice.
<details>
<summary>Account Service</summary>

- [API Documentation](https://amplicalabs.github.io/account-service/)
- [GitHub](https://github.com/AmplicaLabs/account-service)
- [API Documentation](https://amplicalabs.github.io/gateway/account)
- [README](./services/account/README.md)

</details>

<details>
<summary>Graph Service</summary>

- [API Documentation](https://amplicalabs.github.io/graph-service/)
- [GitHub](https://github.com/AmplicaLabs/graph-service)
- [API Documentation](https://amplicalabs.github.io/gateway/graph/)
- [README](./services/graph/README.md)

</details>

<details>
<summary>Content Publishing Service</summary>

- [API Documentation](https://amplicalabs.github.io/content-publishing-service/)
- [GitHub](https://github.com/AmplicaLabs/content-publishing-service)
- [API Documentation](https://amplicalabs.github.io/gateway/content-publishing/)
- [README](./services/content-publishing/README.md)

</details>

<details>
<summary>Content Watcher Service</summary>

- [API Documentation](https://amplicalabs.github.io/content-watcher-service/)
- [GitHub](https://github.com/AmplicaLabs/content-watcher-service)
- [API Documentation](https://amplicalabs.github.io/gateway/content-watcher/)
- [README](./services/content-watcher/README.md)

</details>

Expand Down Expand Up @@ -177,7 +177,6 @@ Contributions, issues, and feature requests are welcome!

- [Contributing Guidelines](./CONTRIBUTING.md)
- [Open Issues](https://github.com/AmplicaLabs/gateway/issues)
- See also the repositories of the individual services.

<p align="right">(<a href="#-table-of-contents">back to top</a>)</p>

Expand All @@ -196,4 +195,3 @@ Thank you to [Frequency](https://www.frequency.xyz) for assistance and documenta
This project is [Apache 2.0](./LICENSE) licensed.

<p align="right">(<a href="#-table-of-contents">back to top</a>)</p>
````
34 changes: 20 additions & 14 deletions services/content-publishing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

- [📖 About the Project](#about-project)
- [🔍 Arch Map](#-arch-maps)
- [🛠 Built With](#-built-with)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live OpenAPI Docs](#-live-docs)
Expand All @@ -22,7 +22,7 @@
- [Linting](#linting)
- [Formatting](#auto-format)
- [🤝 Contributing](#-contributing)
- [⭐️ Show your support](#-support)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#-acknowledgements)
- [❓FAQ](#faq)
- [📝 License](#-license)
Expand Down Expand Up @@ -116,6 +116,7 @@ The Content Publishing Service consists of two applications: an API controller,
### Key Features

#### API

- **Upload asset files**
- **Create a broadcast(post)**
- **Create a reply**
Expand All @@ -125,6 +126,7 @@ The Content Publishing Service consists of two applications: an API controller,
- **Update a user profile**

#### Development API

- **Get the details of a job**
- **Get asset**
- **Populate a queue with dummy announcement data**
Expand Down Expand Up @@ -203,31 +205,35 @@ To run the project, execute the following command:

#### 2. Start the application services

Each of the application services may be run either under Docker or bare-metal, depending on your preferred development workflow.
Each of the application services may be run either under Docker or bare-metal, depending on your preferred development workflow.

The instructions are the same for running both the API service and the worker service:

- **Substitute "api" or "worker" for the "< service >" tag in the commands below.**

#### Running bare metal
- **Substitute "api" or "worker" for the "< service >" tag in the commands below.**

#### Running bare metal

```sh
npm run start:<service>::dev
```

-- or --

#### Running under Docker
#### Running under Docker

```sh
docker compose up [-d] content-publishing-service-<service>
```

#### 3. Check the job in BullUI, to monitor job progress based on defined tests.
#### 3. Check the job in BullUI, to monitor job progress based on defined tests

### Swagger UI
Check out the Swagger UI hosted on the app instance at http://localhost:3000/docs/swagger to view the API documentation and submit requests to the service.

Check out the Swagger UI hosted on the app instance at <http://localhost:3000/docs/swagger> to view the API documentation and submit requests to the service.

### Queue Management
You may also view and manage the application's queue at http://localhost:3000/queues.

You may also view and manage the application's queue at <http://localhost:3000/queues>.

### Run tests

Expand All @@ -237,13 +243,13 @@ To run tests, run the following command:
npm test
```

### Linting:
### Linting

```sh
npm run lint
```

### Auto-format:
### Auto-format

```sh
npm run format
Expand All @@ -264,7 +270,7 @@ Contributions, issues, and feature requests are welcome!

<!-- SUPPORT -->

## ⭐️ Show your support
## ⭐️ Show your support <a name="support"></a>

If you would like to explore contributing bug fixes or enhancements, issues with the label `good-first-issue` can be a good place to start.

Expand Down Expand Up @@ -292,4 +298,4 @@ Thank you to [Frequency](https://www.frequency.xyz) for assistance and documenta

This project is [Apache 2.0](./LICENSE) licensed.

<p align="right">(<a href="#-table-of-contents">back to top</a>)</p>
<p align="right">(<a href="#-table-of-contents">back to top</a>)</p>