Skip to content

Commit

Permalink
Added demo info, added todo list
Browse files Browse the repository at this point in the history
  • Loading branch information
Otoniel Reyes committed Aug 23, 2021
1 parent 98d8d63 commit 6ef1f3b
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Frontsite
Create a site for your app.

## Demo
If you want to see, the final result after running this generator in a blank rails app, you can visit the [demo](https://github.com/kenliten/frontsite-demo) [here](https://frontsite-demo.herokuapp.com).

## Installation
Add this line to your application's Gemfile:

Expand All @@ -25,8 +28,19 @@ Run the generator:
$ bin/rails g frontsite:install
```

## TODO
The project isn't complete yet.
Next, I'll implement these features:
- Default privacy policy page
- Default terms & condition page
- Default contact mailer
- Functional contact form
- Some default (custom) error pages
- Feed/Newsletter capabilities
- A complete test suite for the engine

## Contributing
Contribution directions go here.
If you have some ideas or the time to create any of the items above, feel free to help here, using the [issues](https://github.com/kenliten/frontsite/issues) tool. Contributions are welcome.

## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

0 comments on commit 6ef1f3b

Please sign in to comment.