Skip to content

TerryLeeAllenJr/alien-fish-api

Repository files navigation

Alien Fish Logo

License Commit Activity Tests Build Commit Activity License Twitter

Alien Fish Consulting (API)

Please note that at this time this is a work in progress, and is in it's very early stages.

Alien Fish Digital Consulting is an open source learning, training, and digital collaboration platform founded by Lee Allen and Robert Herring in March of 2023.


API Core Concepts

  • Built on Laravel (v.10.10.0)
    • Leverages Laravel Sanctum in addition to the AlienFish\Core Laravel package to provide secure authentication along with robust Privilege Access Management.
    • Includes a pre-configured custom docker-compose.yamlfile leveraging Laravel Sail for ease of environment setup.
    • Adheres to all Laravel best practices. We do not, and will never "hack the core."
  • Leverages the AlienFish\Events Laravel package to provide a scaleable, real time, event driven architecture across all applications, websites, and microservices within the Alien Fish ecosystem.
    • At launch time, this package will only support AWS integration.

Installation

Coming Soon


Helpful Links

Postman API collection + documentation.

Laravel documentation.

Contributing

Alien Fish aims to prove that open source is secure, efficient, and can make a lasting impact on businesses and the tech culture as a whole. We welcome, embrace, and hope that as our community grows, more and more people will be willing to contribute. As such, all aspects of our codebase will be open source... forever. However, we will also always reserve the right to curate, modify, or flat our refuse any and all changes requested to the platform.

This is not to discourage contribution, but to ensure code quality, the quality of our platform, and the security of our users.

Code of Conduct

In the spirit of open source, we ask that you conform to the Laravel Code of Conduct. Yes, we're currently too lazy to write our own... but honestly, it's just that damn good.

Security Vulnerabilities

We pride ourselves on being a secure, open source community. If you discover any security vulnerability with our codebase, please send an email to Lee Allen via lee.allen.sc@gmail.com. Maybe one day we can have a bounty program, but for the moment I'm too broke. I'll definatley buy you a beer (or a soda if that's your bag.)

License

The Laravel framework is open-sourced software licensed under the MIT license.

About

Real time, event driven backend for the Alien Fish Digital Consultants platform.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages