Juan Rodriguez
45 lines
852 B
Markdown
45 lines
852 B
Markdown
# url-shortener
|
|
|
|
TODO: Write a description here
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
brew tap amberframework/micrate
|
|
brew install micrate
|
|
|
|
shards install
|
|
```
|
|
|
|
TODO: Write installation instructions here
|
|
|
|
## Usage
|
|
|
|
TODO: Write usage instructions here
|
|
|
|
## Development
|
|
|
|
```bash
|
|
DATABASE_URL=sqlite3://./sqlite/data.db micrate up
|
|
crystal run url-shortener.cr
|
|
```
|
|
|
|
## Build
|
|
|
|
```bash
|
|
crystal build url-shortener.cr --release --progress
|
|
ENV=production ./url-shortener
|
|
```
|
|
|
|
## Contributing
|
|
|
|
1. Fork it (<https://github.com/your-github-user/url-shortener/fork>)
|
|
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 a new Pull Request
|
|
|
|
## Contributors
|
|
|
|
- [Juan Rodriguez](https://github.com/your-github-user) - creator and maintainer
|