These instructions will get a copy of this project running on your machine for development and testing purposes.
This project requires Crystal
The version of Crystal used is defined inside
I'd recommend using crenv to install the current version of Crystal, which is as simple as the following command inside the project folder.
There are also some other dependencies required for some extensions of Crystal and Amber, as well as PostgresQL.
sudo apt install -y postgresql libssl-dev libxml2-dev libyaml-dev libgmp-dev libreadline-dev libevent-dev libsqlite3-dev
brew tap amberframework/amber brew install amber brew install postgresql
Unless you've used Postgres before, or know your way around configuring it already, you'll probably want to follow this quick guide to setting up users for development.
# start a session as the postgres user sudo su - postgres; # create a user named postgres if it doesn't already exist create user skirmish; # then grant it super user access alter user skirmish with superuser; # optionally create a user to login to postgres yourself create user <username> --pwprompt; # exit the session as postgres exit
# start a session as the postgres user psql postgres # create a user named postgres if it doesn't already exist create user skirmish; # then grant it super user access alter user skirmish with superuser; # exit the session as postgres exit
To change the authentication with postgres to use a simple password 'trust' authentication method, we'll need to edit the
sudo vim /etc/postgresql/9.5/main/pg_hba.conf
trust on the lines for local connections
# IPv4 local connections: host all all 127.0.0.1/32 trust # IPv6 local connections: host all all ::1/128 trust
Restarting the Postgres service
And finally, ensure the settings for postgres have been applied by restarting the service
sudo service postgresql restart
brew services restart postgresql
To start your Amber server (Both Linux and Mac):
# update the development environment settings to your liking cp config/environments/development.yml.example config/environments/development.yml shards install # install dependencies shards build # build executable binaries crystal ./src/sam.cr -- db:setup # create the database and bring it up to speed bin/amber db seed # optionally seed the database with some mock data bin/amber watch # start the server and watch for file changes
Now you can visit http://localhost:3000/ from your browser.
To run the test suite:
Possible Installation Issues
Some setups are hitting undefined
bind_ssl method errors within Amber itself. The good news is that we don't actually need it.
Error in src/skirmish.cr:3: instantiating 'Amber::Server:Class#start()' Amber::Server.start ^~~~~ in lib/amber/src/amber/server/server.cr:17: instantiating 'Amber::Server#run()' instance.run ^~~ in lib/amber/src/amber/server/server.cr:50: instantiating 'start()' start ^~~~~ in lib/amber/src/amber/server/server.cr:62: undefined method 'bind_ssl' for HTTP::Server server.bind_ssl Amber.settings.host, Amber.settings.port, ssl_config, settings.port_reuse ^~~~~~~~ Rerun with --error-trace to show a complete error trace.
Open the breaking file
And comment out lines 60-63 and 65
# if ssl_enabled? # ssl_config = Amber::SSL.new(settings.ssl_key_file.not_nil!, settings.ssl_cert_file.not_nil!).generate_tls # server.bind_ssl Amber.settings.host, Amber.settings.port, ssl_config, settings.port_reuse # else server.bind_tcp Amber.settings.host, Amber.settings.port, settings.port_reuse # end
- Fork it
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin my-new-feature)
- Create a new Pull Request