Skip to content

upayanmazumder/Collaborative-Article-Sharing

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Collaborative-Article-Sharing

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

Links

Site Button
API Button
PyPI Button
Discord Button


CLI Tool

Install the CLI tool with:

pip install collaborative-article-sharing

Commands

For detailed instructions on using the CLI, refer to its README file.


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 APP folder, navigate to the app directory and run:

    npm install
  • For the API and CLI folders, navigate to their directories and run:

    pip install -r requirements.txt

Running the Project

  • To start the APP, navigate to the app directory and run:

    npm run dev
  • To start the API, navigate to the api directory and run:

    python main.py
  • To run the CLI, refer to its README file.