New Reads

This is a webapp written in Crystal and powered by the Amber Framework. This webapp acts as a library where users store their books and can write notes + reviews about said books.

Getting Started

These instructions will get a copy of this project running on your machine for development and testing purposes.

Please see deployment for notes on deploying the project in production.

Prerequisites

This project requires Crystal (installation guide).

Development

To start your Amber server:

1. Install dependencies with shards install
2. Build executables with shards build
3. Create and migrate your database with bin/amber db create migrate. Also see creating the database.
4. Start Amber server with bin/amber watch

Now you can visit http://localhost:3000/ from your browser.

Getting an error message you need help decoding? Check the Amber troubleshooting guide, post a tagged message on Stack Overflow, or visit Amber on Gitter.

Using Docker? Please check Amber Docker guides.

Tests

To run the test suite:

crystal spec

Contributing

1. Fork it ( https://github.com/materialfuture/amber-library-webapp/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

• your-github-user Konstantine(MaterialFuture) - creator, maintainer

TODO

• Add more validation routes like /book/new
• Add roles to users via a roles table and foreign key assignment
• Further integrate relation of books to users and so forth