Aardwolf

About

Unlike mainstream social media sites that funnel the world into a single (advertising-filled) shared experience, we recognize that individuals with different identities and interests. Aardwolf is a free, and open-source alternative to Facebook which respects user privacy. Aardwolf servers (also called instances) are able to be customized to fit your community's needs, while still being able to communicate to one another.

Project Tour

• .github/ -- CI/CD Files related to GitHub
• aardwolf-actix/ -- The Actix backend rust application code
• aardwolf-models/ -- Web app models, and database setup files
• aardwolf-templates/ -- Legacy Frontend files
• aardwolf-test-helpers/ -- Development functional test code
• aardwolf-types/ -- Additional web app components
• aardwolf-yew-frontend/ -- The Yew frontend application code
• config/ -- Aardwolf app configuration files
• doc/ -- Documentation
• docker/ -- Docker files
• po/ -- Legacy directory for i18n translations
• src/ -- The source directory for the main app (pulls in other parts)
• tests/ -- Where the code validation, and coverage tests should live
• build.rs -- Rust code that directs Cargo build
• Cargo.lock -- A complete manifest of all rust crates used, including dependencies
• Cargo.toml -- A manifest of crates required to build Aardwolf
• CODE_OF_CONDUCT.md -- Our Code of Conduct rules
• db-init.sh -- This should be part of the setup/install scripts
• diesel.toml -- Tells diesel where to find the SQL migrations
• LICENSE -- The license we use for this software
• README.md -- The file you are presently reading
• ROADMAP.md -- Our development roadmap
• rust-toolchain.toml -- This tells the development environment which version of rust to use.
• SECURITY.md -- Future info for security updates
• translations -> aardwolf-templates/translations

Homepage Screenshot

This is a screenshot of the static HTML demo. While not a final version it does showcase the design intentions.

Code of Conduct

As a COMMUNITY it is very important to us that we maintain a positive and supportive environment for everyone who wants to participate. When you join us we ask that you follow our code of conduct in all interactions both on and offline.

Contributing

Here are the areas we could use help with!

• Rust Developers, folk that want to learn are welcome! - Rust
• Frontend Developers, HTML/CSS folks that want to help with the UI/UX part of the project.
• Documentation help. Proofreading, organization, update wiki, etc.
• Docker containers/VM's. Some progress has been made building Docker images (for developement)

Once your ready to dive in please check out our contributor's guidelines, and our roadmap.

List of Repositories

Currently Aardwolf-Social is broken down into several repositories

• Aardwolf-Social "Main", the one you are presently on.
• Aardwolf Interface, a repo to independently work on, and test Frontend development.
• Aardwolf Website, is where the Jekyll site is deployed from.

Contact

If you have ANY questions please feel free to reach out to us!

• Chat Room: Follow the link to choose your connection method :) #aardwolf-discussion:matrix.org
• Mastodon: @banjofox2@hackers.town.

License

All Aardwolf software is licensed under the GNU Affero General Public License