README

Development setup

Ensure you have ruby (version 3.2) installed, for instructions see the Install Rails Howto.
Ensure you have node.js installed
Ensure you have the postgresql database installed
- macOS: brew install postgresql then follow instructions
- windows: https://www.postgresql.org/download/windows/, then follow instructions and make a note of the username & password
- Linux: depending on your distribution install, configure and start postgresql:
  1. Create user in posgres: sudo -u postgres createuser username
  2. Give permission to user to create database: sudo -u postgres psql and in the postgres terminal: ALTER USER username CREATEDB;
Ensure you have PostGIS installed. For instructions, check the project's website.

Clone the repository to your computer

git clone https://github.com/sharkipedia/sharkipedia.git

Move into the project folder (cd sharkipedia)
Install project dependencies: bundle install
Windows/Linux: in the config/database.yml configure the username and password under development which you set during the installation of postgresql. macOS: if you installed postgres with brew you don't need to do anything, if you installed postgres in another way you might have to configure a username and password
Initialize the database rake db:setup (if this command throws an role "username" does not exist or permission denied to create database error, see above to create postgres user and give permission)
Run the rails server rails server
Connect to the application in your browser at http://localhost:3000