Gyro is an Elixir clone of shawarmaspin that @whiterook6 started. The goal of the project is to implement shawarmaspin with scalability and efficiency in mind. The application doesn't actually do any intensive operations. So instead of being performant, Gyro should be easily scaled and support as many users as possible on hardware with as little resources as possible. The plan for production deployment is to rely on the cheapest DigitalOcean droplet box ($5/month) and add more cheap boxes to the network cluster as needed.
To start the app:
- Install dependencies with
mix deps.getandnpm install. - Start Phoenix endpoint with
mix phoenix.server.
Now you can visit localhost:4000 from your browser.
To run the unit tests:
- Install dependencies with
mix deps.get. - Run
mix test.
The general benchmark of the application is done by stress-testing using tsung. Of which, the config file for it is included in the ./test folder of the project.
We are looking for contributors, and there are many ways you can contribute. If you are looking to get some hands on, please feel free to pick up tickets, and submit pull requests! Otherwise, submitting tickets for any issues or improvements would be appreciated.