search

upes-open / OSoC-24-Comic-Craft

A service that transforms written stories into captivating custom comic art, complete with engaging dialogues and visuals.
GNU Affero General Public License v3.0
1 stars 9 forks source link

readme

Comic Craft: Transform Your Stories into Stunning Comics

Project Description

Many writers and storytellers struggle to bring their narratives to life in a visual format. Traditional comic creation can be time-consuming and require artistic skills that not everyone possesses. Our platform offers a seamless process for users to transform their written stories into visually stunning comics. By leveraging design with dialogue integration, users can create custom comic art that captures the essence of each narrative. The final product, a polished PDF, will be delivered to the user's inbox, providing a convenient solution for storytellers looking to enhance their tales with vibrant visuals.

Technology Stack

My Skills

Installation

  1. Install NodeJS LTS (v20.14.0): Click Here
  2. Node-based projects: 
    cd <folder_name>
npm i
npm run dev

Setup

  1. Create a fork of the repository
  2. Clone the forked repository: 
    git clone https://github.com/upes-open/OSoC-24-Comic-Craft
  3. Open the cloned repository in your preferred code editor (e.g., VS Code, Zed, Sublime Text)

Contributing

  1. Create a branch: 
    git checkout -b <your_username>
  2. Issues:
    • Find the active issues in the Issues tab.
    • Comment on the issue, and get yourself assigned to it.
  3. Complete the issue and raise a Pull Request containing the issue number, e.g.: 
    git add .
git commit -m "Fixes #23"
git push -u origin <branch_name>
  4. Wait for the code review and pull request merge.

Rules

  1. There are 3 levels of issue difficulty:
    1. Easy: Beginner level and easy to solve. (10 points)
    2. Medium: Intermediate level and a bit tricky to solve. (20 points)
    3. Advanced: Advanced level and includes advanced concepts of the technology stack. (30 points)
  2. Direct commits on the main branch are restricted. Creating a branch is mandatory.
  3. Pull requests without the issue number will not be merged.
  4. Scores will be declared weekly on the OPEN's website and Discord.
  5. All discussions should be performed on the Discord server or GitHub.
  6. Raising and solving a self-issue will not be considered as a legitimate contribution. See Innovation Center.

Innovation Center

If a contributor wants to introduce a new feature not mentioned in the issues, they must discuss it with the repository maintainer. The maintainer will raise the issue and assign it to the respective contributor.

Help Center

In case of any problem, kindly reach out to us via email at upesopen@gmail.com.

Disclaimer

This project is under OSoC'24, organized by OPEN Community, UPES. All projects are open source with a copyleft license. Kindly review the licensing terms thoroughly to avoid any issues in code distribution. [LICENSE](). Any violation of the licensing terms will lead to unavoidable consequences.

LICENSE