autorecord

Generate beautiful lab records with a single click!

Watch YouTube Tutorial
Important: Run the One-Time Setup and Running Autorecord before using the web interface.

Table of Contents

• One-Time Setup for Autorecord
• Running Autorecord
• Get Your Lab Report as PDF
• Contribute
• Additional Directories
• Credits

One-Time Setup for autorecord

Ready to use Autorecord? Here's a quick setup:

1. Install Docker: Head to the official website (https://docs.docker.com/guides/getting-started/) and download Docker for your system.
2. Create App Data Volume: Open your terminal and run this command to create a storage area for autorecord's data:

docker volume create autorecord-appdata

3. Pull Docker Images: Run the following command to pull the backend image:

docker pull krishnachandranu/autorecord-backend:v2

Tip: These commands might take a while depending on your internet speed.

Running autorecord

Ready to start making records? Here's how to launch autorecord:

1. Run Backend: Open a terminal or command prompt, run this command to start the backend of autorecord:

docker run -v autorecord-appdata:/.appdata -p 5000:5000 krishnachandranu/autorecord-backend:v2

All set!: After the container is running, open your web browser and go to autorecord.

Get Your Lab Report as PDF

Ready to download your lab report? Here's how:

1. Save your work: Make sure all your edits are complete, then click Save in autorecord.
2. Download your files: Click Get ZIP to create a compressed file containing everything for your report.
3. Upload to Overleaf: If you don't have an Overleaf (Click Here) account, create one for free! Then, click New Project and choose Upload to select the downloaded ZIP file.
4. Get your PDF: Overleaf will automatically set up your project. Finally, click the Download PDF button (looks like a download icon) on the top of the rendered PDF to save your lab report as a PDF!

Contribute

To contribute, follow these steps:

1. Install Docker on your machine. You can download Docker from the official website: https://www.docker.com/get-started.

2. Install Python with pip. You can download Python from the official website: https://www.python.org/downloads. Make sure to select the option to install pip during the installation process.

3. Install Git on your machine. You can download Git from the official website: https://git-scm.com/downloads.

4. Install npm (Node Package Manager) on your machine. You can download Node.js, which includes npm, from the official website: https://nodejs.org/en/download.

5. Once Docker, Python with pip, Git, and npm are installed, open a terminal or command prompt and navigate to the project directory.

6. Run the following command to build and start the Docker containers:

docker compose up --build

if it doesn't work, run:

docker-compose up --build

7. After the containers are built and running, open your web browser and go to http://localhost:3000.

Additional Directories

The project includes the following additional directories:

• /backend for backend
• /webui for Next.js frontend
• /backend/api has the APIs built using Flask
• /backend/api/readme.md has the API documentation
• /backend/template has the base LaTeX template

Credits

Special thanks to the following individuals for their direct and/or indirect contributions:

• Don Jose Mathew
• Jiya Rose Joshy
• Meenakshy Sudhir
• Riya Sabu
• Mohamed Irfan AM
• Nimmi M Giji
• Aravind Suresh Thakidayil
• Alex Sabu
• Joshua T Joy
• Pranav Jayachandran
• Ajay Krishna K V
• Arjun A I
• Vishnu Shaji