Skip to content

Commit

Permalink
Enhance README.md and CLI documentation with additional commands, imp…
Browse files Browse the repository at this point in the history
…roved formatting, and developer setup instructions
  • Loading branch information
upayanmazumder committed Dec 12, 2024
1 parent 4b657d7 commit 9994655
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 10 deletions.
4 changes: 3 additions & 1 deletion CLI/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ A Command-Line Interface (CLI) tool for interacting with the [Collaborative-Arti

### Available Commands

> For a full comprehensive list, use the help command
- **`cas info`**
Displays project and developer information.

Expand Down Expand Up @@ -31,7 +33,7 @@ A Command-Line Interface (CLI) tool for interacting with the [Collaborative-Arti
- **`cas group:list`**
Get the list of public groups

> For a full comprehensive list, use the help command
### Development

To run the CLI tool, first navigate to the CLI folder using the command:

Expand Down
60 changes: 51 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Collaborative-Article-Sharing

<space><img src='https://cas.upayan.dev/favicon.ico' height=50px>
<img src='https://cas.upayan.dev/favicon.ico' height=50px>

A collaborative article-sharing system for seamless content exchange and engagement.
A collaborative article-sharing system designed for seamless content exchange and engagement.

## Links

Expand All @@ -11,6 +11,8 @@ A collaborative article-sharing system for seamless content exchange and engagem
[![PyPI Button](https://img.shields.io/badge/PyPI-CAS-orange?style=for-the-badge&logo=pypi&logoColor=white)](https://pypi.org/project/collaborative-article-sharing/)
[![Discord Button](https://img.shields.io/badge/Discord-Join%20Community-blue?style=for-the-badge&logo=discord&logoColor=white)](https://discord.com/invite/wQTZcXpcaY)

---

## CLI Tool

Install the CLI tool with:
Expand All @@ -21,12 +23,52 @@ pip install collaborative-article-sharing

### Commands

For detailed instructions on using the CLI, please refer to [its specific README file](./CLI/README.md)
For detailed instructions on using the CLI, refer to its [README file](./CLI/README.md).

---

## Ports

| Service | Port |
|--------------------|------|
| APP | 3000 |
| API | 4000 |
| CLI Authentication | 8000 |

---

## Developer Guide

### Environment Setup

1. Fill the `.env` file in the root directory and the `app` directory with the required environment variables.

### Package Installation

- For the **API** folder, navigate to the `api` directory and run:

```bash
npm install
```

- For the **APP** and **CLI** folders, navigate to their directories and run:

```bash
pip install -r requirements.txt
```

### Running the Project

- To start the **APP**, navigate to the `app` directory and run:

```bash
npm run dev
```

- To start the **API**, navigate to the `api` directory and run:

### Ports
```bash
python main.py
```

| Service | Port |
|---------|------|
| APP | 3000 |
| API | 4000 |
| CLI Authentication | 8000 |
- To run the **CLI**, refer to its [README file](./CLI/README.md).

0 comments on commit 9994655

Please sign in to comment.