Live demo on => heroku
- Clone the application with
git clone https://github.com/FottyM/forum_api.gitor use sshgit clone git@github.com:FottyM/forum_api.git.
- Ruby version 2.2.1 and above
- Rails 4.0.0
- PostgreSQL
Run these commands from terminal:
sudo apt-get -y update
sudo apt-get -y install postgresql postgresql-contrib
Once you have postgresql installed, create a superuser for postgresql
adduser <username>
passwd <password>
after which you can type in
su - postgres
on macOs with homebrew brew install postgresql or download the postgresql client for mac
Once you have all the dependencies, you can then run your command line and navigate into the project's folder and then run:
- Run
bundle installto install all other dependencies
Alternatively you can run our automated script by doing the following
-
Give the script execution permissions by running
chmod +x install.sh -
Run
./install.shto install all other dependenciesNote some gems might cause issues while installing, so for unix/linux users try
sudo gem install <gem_name> -
Run
rails db:setupto set up the db, run the migrattions and seed the db all at once. or, -
Run
rails db:migrateorrake db:migrateand then, -
Run
rails db:seedorrake db:seed.
(the rake command was used for rails version prior rails 5. But it is no logner required)
You can then run rails s or rails server and visit the page on the browser by typing localhost:3000. (you can add the flag -p <port_number> to specify a different port number, e.i. rails s -p 8000)
After all the setting up as mentioned above, you can run the tests. The tests are driven by rspec, capybara and selenium. You can get them fired up by running the following command from the terminal.
rspec spec
or
bundle exec rspec
- Write a question and explanations
- Answer to questions
- Delete questions/answers if you're the owner or if you've the admin right
- Register with username and password
- log in/log out
- authenticate with jwt