Further documentation can be found at https://hexdocs.pm/charty.
See the flake.nix for the dependencies of this project.
gleam run # Run the project
gleam test # Run the tests- improve
README.md - zoom into images on click
- only read files from the uploads directory that are images
- check if the images are images on upload on the server side else error
- fix the image spacing
- make dashboards with multiple rows of images
- clean up the styles (low priority for now)
- do Hex Docs
- do Package version
I welcome contributions to this project! If you have an idea for an enhancement or find a bug, feel free to submit a Pull Request (PR). To ensure consistency and maintain code quality, please follow these guidelines:
-
Fork the Repository: Start by forking this repository and cloning it to your local machine.
-
Create a Branch: Create a new branch for your feature or bugfix. We recommend using a descriptive branch name, e.g., feature/new-awesome-feature or fix/issue-123.
-
Code Style: Please ensure that your code is in line with the existing style and adheres to the project’s formatting standards. We use the Gleam formatter to maintain a consistent style. Before submitting your PR, run the formatter using gleam format.
-
Write Tests (if and only if reasonable): If your contribution involves code changes, make sure to include tests to cover your modifications. This helps us ensure that the project remains robust and reliable.
-
Submit a Pull Request: Once your changes are ready, push your branch to your fork and open a PR against the main branch of this repository. Provide a clear and concise description of your changes and reference any related issues.