yaowzers / cvwo

Chek (CVWO Project)

Chek is a To-Do application for Volunteer Organisations to keep track of current deadlines and tasks on hand.

Chek uses a React frontend, with Ruby as the API and Postgresql as the database.

Installation

Clone the Repostitory

git clone https://github.com/yAOwzers/CVWO.git
cd CVWO

Check your Ruby version

ruby -v

Ensure that your Ruby version is ruby 2.7.2 If not, you can install the right ruby version using rbenv:

rbenv install 2.7.2

Dependencies

Ensure that you download both Bundler and Yarn.

Installing Bundler

To install (or update to the latest version):

gem install bundler

If there are any issues, refer to the troubleshooting section.

Installing Yarn

You can install Yarn following the steps on the website.

Database

Ensure that you install Postgresql for the database.

To create the database

rails db:create

To initialize the database

rails db:migrate

Other Add Ons

Fast Json API

Fast Json for the API serialization.

You can refer to the repo here.

Installation

Add this line to your application's Gemfile:

gem 'fast_jsonapi'

Execute

$ bundle install

Starting the Server

Start the server by executing the following command:

$ rails s

You should see a default template of Rails when entering localhost:3000 in the url of your browser.

Things to Include in later

• System dependencies

• How to run the test suite

• Services (job queues, cache servers, search engines, etc.)

• Deployment instructions

cvwo's Issues

As a user, I will want to filter out my tasks by catergories.

So that I can view specific categories of choice, such as deadlines.

As a user, I want to view all the task at hand

So that I can have a broad overview of the tasks currently

As a user, I will want a search function.

So that even with a lot of tasks at hand, I can easily search the tasks with the specific keyword.

As a user, I will want to see a progress bar.

So that I will be able to keep track of my progress without viewing all my tasks.

As a user, I will want to be able to mark my task as done.

So that I will be able to keep track of what is done and what is incomplete.

As a user, I will want to be reminded of the deadlines.

So that I will know what to prioritize.

Implement Ruby API

Basic CRUD features

Implement progress bar feature

Implement a search feature

Implement a search feature

Implement a CRUD structure where users can create, read, edit and delete

Use of scaffolds

As a new user, I will want to have tutorials and guides.

So that I will not be confused when first using the platform.

Implement a filter feature

Implement a mark as done feature