Journey into the aether where storage defies conventional bounds.

aether is a modern file storage platform that implements a state-of-the-art Merkle tree structure to store multiple files.

• 1. Overview
  • 1.1. Project structure
• 2. Development
  • 2.1. Requirements
  • 2.2. Setting up environment variables (optional)
  • 2.3. Running locally
• 3. Appendix
  • 3.1. Useful commands
  • 3.2. Docker Compose service directory
• 4. How To Contribute
• 5. License

The project structure is loosely based on the layout outlined in golang-standards/project-layout. The exceptions are:

• The web directory has been renamed to app to conform to the Next.js project structure.
• The public directory contains static assets for the web app to conform to Next.js project structure.

^{Back to top ^}

• Docker
• Docker Compose v2.5.0+
• Make
• Node v20.9.0+
• Yarn v1.22.5+

^{Back to top ^}

1. Create the .env.* files for each application to the .config/ directory:

make setup

2. Go to the .config/ directory and edit each .env.* file.

^{Back to top ^}

1. Simply run:

make

⚠️ NOTE: The make command will run/re-run make setup, but will not overwrite any .env.* that may have been edited in section 1.2.

2. Navigate to http://localhost:8080 to access the web portal.

^{Back to top ^}

^{Back to top ^}

Here is a list of all the localhost port mappings for each of the apps

^{Back to top ^}

Please read the Contributing Guide to learn about the development process.

^{Back to top ^}

Please refer to the COPYING file.

^{Back to top ^}