Ilya-Meer / event-point

An event tracker
0 stars 2 forks source link

Event Point

An event tracker for Evident Point to assist with scheduling internal meetings and events.

Prerequisites

Configuration

Steps to follow to get up and running with this project:

1. Clone the repo

git clone https://github.com/Ilya-Meer/event-point.git

2. Install dependencies

bundle install # Install Rails and other Ruby gems
yarn install # Install npm packages necessary for client-side development

3. Create database.yml file

Copy the sample-database.yml file and edit the database configuration as required.

cp config/sample-database.yml config/database.yml

4. Create the database

bundle exec rake db:create
bundle exec rake db:migrate
bundle exec rake db:seed # optional

5. Start the server

bundle exec rails s

After completing the above, you should be able to access the app on http://localhost:3000.

CSS

This project currently uses the out-of-the-box SCSS that comes with Rails. But this is only because this project was meant to be a proof of concept. In the event that more resources are directed to this, any more suitable solution can be used instead.

Testing

Test scripts for both server and client side test suites can be found in package.json at project root.

Client-side testing is done with Jest and @testing-library/react.

Server-side testing is done with...Rails, of course!

Contributing

New issues and PRs are always welcome!