benfluleck / hey_car

Hey Car

Table of Contents

• Getting Started
• Technology Stack
• Installation
• Testing
• Questions
• Support or Contribution
• Status

Getting Started

This is a clientside javascript application built React JS application. The data exists on endpoints serve through the Poll api

Technology Stack

Client Side

1. Github actions
2. React JS
3. Netlify

Installation

1. Install Node JS.

2. Clone the repository here

3. [cd] into the root of the project directory.

4. Run npm install on the terminal to install project dependecies

5. Start the application:

Build Environments

For Client

Development

npm run serve

Webpack should open your default browser automatically

• Navigate to http://localhost:7000

CI/CD

The project uses a combination of Github Actions and Netlify. Each PR is tested and deployed on here

Testing

Client side tests - Run npm run test on the terminal while within the project root directory.

Client side testing is achieved through the use of jest package. jest is used to test javascript code in React applications.

Client side testing is yet to be configured but is being worked on currently

Questions

For more details contact [e-mail]

Support or Contribution

For any suggestions or contributions or issues please do raise them or email me. For Contributiions, Please clone the repo and implement a PR I would appreciate it

Status

Still undergoing testing