LEPHUCR Overleaf

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 [[Lee esto para hacer un cambio real (LEPHUCR)]]

Spanish written book about technocriticism from a libidinal hacker.

[LEPHUCR and other texts] is a book splitted in multiple fascicles and we try to use emojis and cool stuff whenever we find a good opportunity.

🛠 Built With

Tech Stack

LaTeX based book with some scripts to generate a fanzine from the actual markdown content.

Client

• Next.js

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

This book is publishable through Gollum and we aim to provide an User Interface to edit markdown texts.GitHub Action to auto-publish once a Pull Request is approved. 1-3 key features of the application.

• [Public GitHub Action]
• [Front-end to edit the text, add images and bibliography]
• [Bibliography]

(back to top)

🚀 Live Demo

You can buy the latest version here.

(back to top)

💻 Getting Started

Describe how a new developer could make use of your project.

To get a local copy up and running, follow these steps.

Using Docker container in a LaTeX project

TODO: Paste to Obsidian from Telegraph

Online (Overleaf)

Follow this tutorial to get started with Overleaf: https://www.overleaf.com/learn/how-to/Using_Git_and_GitHub

Local (Docker)

The current Docker Setup is done inspired by this article: https://towardsdatascience.com/three-ways-to-create-dockernized-latex-environment-2534163ee0c4

GitHub Actions

Docker Installation

In order to run this project you need:

• docker and docker-compose
  • gollum
  • latex suite

Setup

Clone this repository to your desired folder:

Install

Install this project with:

Usage

To run the project, execute the following command:

Run tests

To run tests, run the following command:

  bin/rails test test/models/article_test.rb

Deployment

You can deploy this project using:

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 Angel Mora

• GitHub: @angel-mora
• LinkedIn: @angelmoradev

👤 Aradnix

• GitHub: @aradenatorix

(back to top)

🔭 Future Features

Receive a bunch of chapters, bibliography, photos and other stuff to generate a standard 1/4 A4 fanzine from it.

• [Syncs org/md/tex]
• [Creates proper indexing from the references]
• [Searches for a potential reference to link from the content]
• [Exports Reveal.js presentation]
• [Exports lean beautiful html website]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, please give it a ⭐️! Donate by:

• PayPal
• Gumroad
• Patreon
• Ko-fi
• Liberapay
• Buy me a coffee
• GitHub Sponsors
• Open Collective
• Bitcoin
• Ethereum
• Bank Transfer (MX)
• Bank Transfer (US)

(back to top)

🙏 Acknowledgments

I would like to thank

• @aradnix
• @ketsapiwi
• @angelacuahutle

(back to top)

❓ FAQ (OPTIONAL)

The following is a list of frequently asked questions about this project.

• [What is the purpose of this project?]

  • [This book is about Activism and TechnoCritique from a Mexican Programmer's perspective to start a discussion about possible futures.]

• [How can I join the conversation]

  • [Join the Telegram group: https://t.me/LaPartidaLEPHUCR]

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)