https://github.com/ebenezr/helpdesk
Web application that curates problems that are faced by students and the possible solutions to these problems.
https://github.com/ebenezr/helpdesk
rails-api reactjs redux-persist redux-toolkit ruby
Last synced: 2 months ago
JSON representation
Web application that curates problems that are faced by students and the possible solutions to these problems.
- Host: GitHub
- URL: https://github.com/ebenezr/helpdesk
- Owner: Ebenezr
- License: mit
- Created: 2022-10-18T20:48:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-24T08:55:42.000Z (over 2 years ago)
- Last Synced: 2025-03-28T18:51:53.233Z (3 months ago)
- Topics: rails-api, reactjs, redux-persist, redux-toolkit, ruby
- Language: JavaScript
- Homepage: http://helpdesk-six.vercel.app
- Size: 10.9 MB
- Stars: 8
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Help Desk
## Contributers
- [Cecilia Anyega](https://github.com/Cecilia5404)
- [Allan Ngoma](https://github.com/allanstar-byte)
- [Alice Auko](https://github.com/aliceauko)
- [Lewis Mwendwa](https://github.com/LewKM)
- [Karugo Murage](https://github.com/karugo-murage)
- [Ebenezar Bukosia](https://github.com/Ebenezr)
---
## Project Description
Helpdesk is a question and answer website for students. A student can ask questions, view previusly assked questions, answer questions and vote for questions that was helpfull. A student can also bookmark a question and be able to follow up on it later.
---
## Demo
### 
---
## Wireframe design
- [Figma](https://www.figma.com/file/xlsyDqdbf9o3UfLrxwQ39j/Helpdesk?node-id=0%3A1)
## Screen shots
### landing page
#### 
---
### home page
#### 
---
### ask question page
## 
### profiles page
## 
## Table of content
- [Technologies](#description)
- [Description](#description)
- [Features](#features)
- [Setup-process](#setup_process)
- [Project-usage](#project-usage)
- [Licence](#licence)
- [Copyright](#copyright)
---
## Technologies
--- Ruby on Rails
--- HTML and CSS
--- JavaScript (React)
--- PostgreSQL
--- Heroku (deployment)
--- Git and GitHub (version control)
--- Minitest (testing)
--- Jest (testing)
---
### Features
--- The features of a HelpDesk web application that allows students to post questions and provide solutions to other questions are as follows:
-- The application allows students to post questions and provide solutions to other questions in a forum-like setting.
-- The application includes a search function that allows students to search for specific questions or topics.
-- The application allows students to up-vote or down-vote questions and solutions, providing a way for the community to rate the usefulness of questions and solutions.
-- The application allows students to comment on questions and solutions, providing a way for the community to provide feedback.
---
### description
--- The HelpDesk web application is a great way for students to get help with their studies.
-- By posting questions and providing solutions to other questions, students can help each other out and learn from each other.
-- This application is a great resource for students who are struggling with a particular subject.
-- By being able to see what other students are asking, they can get a better understanding of the material.
-- Additionally, by providing solutions to other students' questions, they can deepen their own understanding of the subject matter.
---
## How to set up and run the project
### Requirements
--- the following are the requirements for the project
-- Ruby 2.3.3 or later.
-- Rails 5.0 or later.
-- PostgreSQL 9.5 or later.
-- npm
-- node
---
### Dependencies
- rails
- ruby
- node
- npm
### setup
#### Client (React)
clone the repo using the command
```shell
git clone [email protected]:Ebenezr/Helpdesk.git
```
change directory using command
```shell
cd Helpdesk
```
open project in vscode texteditor
```shell
code .
```
install dependancies
```shell
npm install
```
run front end
```shell
npm run dev
```
---
#### API (Ruby on Rails)
clone the repo using the command
```shell
git clone [email protected]:Ebenezr/Helpdesk-api.git
```
change directory using command
```shell
cd Helpdesk-api
```
open project in vscode texteditor
```shell
code .
```
Check your Ruby version
```shell
ruby -v
```
The ouput should start with something like `ruby 2.5.1`
If not, install the right ruby version using [rbenv](https://github.com/rbenv/rbenv) (it could take a while):
```shell
rbenv install 2.7.0
```
install dependancies packages
```shell
bundle install
```
Initialize the database
```shell
rails db:create db:migrate db:seed
```
run api server
```shell
rails s
```
---
## How to use the project
--- To use the project follow the steps below:
-- First sign up to the application.
-- Then you can post a question.
-- You can also give a solution to a question.
-- You can also comment on a question.
-- You can also up-vote or down-vote a question.
## -- You can also search for a question.
### 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
--- This project is licensed under the MIT License - see the LICENSE.md file for details.
---
## [License](LICENSE)
MIT License
Copyright (c) 2022