https://github.com/maskingtechnology/comify
Comic based social network built with Jitar
https://github.com/maskingtechnology/comify
comic comics fun jitar react social-media typescript
Last synced: 6 months ago
JSON representation
Comic based social network built with Jitar
- Host: GitHub
- URL: https://github.com/maskingtechnology/comify
- Owner: MaskingTechnology
- License: agpl-3.0
- Created: 2023-09-11T07:57:28.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-09T15:40:56.000Z (6 months ago)
- Last Synced: 2025-04-09T16:47:30.127Z (6 months ago)
- Topics: comic, comics, fun, jitar, react, social-media, typescript
- Language: TypeScript
- Homepage:
- Size: 2.62 MB
- Stars: 7
- Watchers: 3
- Forks: 3
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Comify
Hi there, and welcome to Comify. 👋
Comify is an open source social media platform that leverages comics for communication. The idea is simple: take or upload a picture, add speech bubbles and share with others. These others can be related or unrelated users, depending on the view you're looking at. Comics can be liked, and users can react with a comment or another comic.
## Project goals
Its intent is not to disrupt the social-media space, but to learn and improve building future-proofed applications that can grow. Besides that, it's also a demo project for our distributed runtime [Jitar](https://jitar.dev).
## Current state
We're working hard to get the MVP done. To document the project we started writing articles about every step we take. You can read them and follow us on our [LinkedIn page](https://www.linkedin.com/company/maskingtechnology/).
## How to run
The project requires [Node.js](https://nodejs.org/) version 20+ to run the application and [Docker](https://www.docker.com/) for the additional services.
You need to set up the configuration first by copying the `example.env` file to a `development.env` file. Copying the file is enough for the first run. Then you can run the following command to start Docker:
```bash
npm run docker-compose up
```
This will start a [Keycloack](https://www.keycloak.org/) instance for account management, a [MongoDB](https://www.mongodb.com/) instance for data storage and a [MinIO](https://min.io/) instance for storing the comic images.
Next you can start the application with the following commands:
```bash
npm install
npm run build
npm run standalone
```
This will start the Jitar runtime at port 3000. To start the application you need to run the following command in a new terminal:
```bash
npm run dev
```
Now a [Vite](https://vitest.dev/) dev server is running on port 5173. You can then navigate to http://localhost:5173 to see the application.
## How to use
Click on the `Get in` button to be redirected to the Keycloak login page. Here you can create your own account and log in directly. If you want to use any of the social options, you need to configure them in `development.env` file. Don't forget to restart Docker afterwards.
Once you're in it should be pretty straightforward. You should be able to comic! If not, please let us know by starting a discussion or creating an issue.
## Contributing
This project is not open for code contributions. However, if you have any questions or suggestions, feel free to contact us at [comify\@masking.tech](mailto:comify@masking.tech?subject=Comify%20question), or post a message in the discussion section of this repository.