library-of-alexandria

(β˜… 137)

Library of Alexandria (LoA in short) is a project that aims to collect and archive documents from the internet.

  • .gitignore
  • build.gradle
  • gradle.properties
  • gradlew
  • gradlew.bat
  • LICENSE
  • lombok.config
  • README.md
  • settings.gradle

# Installation Guide

1. Get the code
git clone https://github.com/bottomless-archive-project/library-of-alexandria

Downloads the entire project code from GitHub to your computer.

cd library-of-alexandria

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended
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.
./gradlew build

Builds the project using Gradle.

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

3. 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 loa-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