Memora

(β˜… 129)

Telegram bot

  • .claudeignore
  • .editorconfig
  • .env.example
  • .gitignore
  • AGENTS.md
  • AMAZONQ.md
  • CLAUDE.md
  • CODEX.md
  • CONTRIBUTING.md
  • README.md
  • STRUCTURE.md

# Installation Guide

1. Get the code
git clone https://github.com/Sunagatov/Memora

Downloads the entire project code from GitHub to your computer.

cd Memora

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f backend/Dockerfile -t memora .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 memora

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Gradle (Java/Kotlin)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
cd backend

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

βœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd frontend

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation