Skip to content

Latest commit

 

History

History
171 lines (109 loc) · 1.99 KB

README.md

File metadata and controls

171 lines (109 loc) · 1.99 KB

Help Desk

Authors

Cecilia Anyega
Allan Ngoma
Alice Auko
Lewis Mwendwa
Karugo Murage
Ebenezar Bukosia

Project Description

Table of content

Technologies

Features

description

How to set up and run the project

Requirements

Dependencies

  • rails
  • ruby

setup

Client (React)

clone the repo using the command

git clone [email protected]:Ebenezr/Helpdesk.git

change directory using command

cd Helpdesk

open project in vscode texteditor

code .

install dependancies

npm install

run front end

npm run dev

API (Ruby on Rails)

clone the repo using the command

git clone [email protected]:Ebenezr/Helpdesk-api.git

change directory using command

cd Helpdesk-api

open project in vscode texteditor

code .

Check your Ruby version

ruby -v

The ouput should start with something like ruby 2.5.1

If not, install the right ruby version using rbenv (it could take a while):

rbenv install 2.7.0

install dependancies packages

bundle install

Initialize the database

rails db:create db:migrate db:seed

run api server

rails s

How to use the project

Contributing to project

  • Fork the repo
  • Create a new branch in your terminal (git checkout -b improve-feature)
  • Install the prerequisites
  • Make appropriate changes in file(s)
  • Run the server to see the changes
  • Add the changes and commit them (git commit -am "Improve App")
  • Push to the branch (git push origin improve-app)
  • Create a Pull request

Copyright

License

MIT License Copyright (c) 2022