https://github.com/zven21/footprint
Track changes to your Ecto Schema.
https://github.com/zven21/footprint
ecto elixir track
Last synced: 3 months ago
JSON representation
Track changes to your Ecto Schema.
- Host: GitHub
- URL: https://github.com/zven21/footprint
- Owner: zven21
- Created: 2019-06-05T07:05:40.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T23:58:12.000Z (over 2 years ago)
- Last Synced: 2025-03-06T09:54:52.918Z (3 months ago)
- Topics: ecto, elixir, track
- Language: Elixir
- Size: 664 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FootPrint
**Track changes to your database with Ecto**
## Table of contents
* [Getting started](#getting-started)
* [Demo](#demo)
* [Contributing](#contributing)
* [Make a pull request](#make-a-pull-request)
* [License](#license)
* [Credits](#credits)
## Getting started
* The package can be installed by adding `footprint` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:footprint, "~> 0.3.1"}
]
end
```
* Add the Repo of your app and the desired per_page to the `footprint` configuration in `config.exs`:
```elixir
config :footprint, repo: MyApp.Rep
```
## Demo
The dummy app shows a simple turbo_ecto example.
Clone the repository.
```bash
https://github.com/zven21/footprint.git
```
Change directory
```bash
$ cd dummy
```
Run mix
```bash
$ mix deps.get && yarn --cwd=assets
```
Preparing database
```bash
$ mix ecto.setup
```
Start the Phoenix server
```bash
$ ./script/server
```
Open your browser, and visit `http://localhost:4000`
## Contributing
Bug report or pull request are welcome.
### Make a pull request
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
Please write unit test with your code if necessary.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
## Credits
* [paper_trail](https://github.com/izelnakri/paper_trail) - Similar implementation.