WIRE

WIRE - Workspace Incident Reporting platform

Getting Started

To get this project up and running locally proceed as follows:

Prerequisites

Software you need to install and how to install:

• You will need to have npm, you can install node using the node.js installer. npm is installed as part of node.
• To use yarn, you'll first need to install it on your system. You can install yarn using yarn installer.

Installing

Series of steps to setup development environment

• Clone the git repository $ git clone https://github.com/AndelaOSP/wire.git

• After cloning the repository into your local machine: $ cd wire

• Then install all the packages NB: Make sure you have a package.json file on the root folder $ yarn install

Run WIRE locally

• You will require to create an alias for wire.andela.com in your /etc/hosts which you can access by running this command sudo vim /etc/hosts which opens your /etc/hosts for editing using vim. To edit it, press i key to get into insert mode and put these 127.0.0.1 wire.andela.com after the last line. Save changes wq after pressing the escape esc key.

• You will need to add the following to your .env file:

NODE_ENV=development
API_URL=http://localhost:3000/api
ANDELA_API_BASE_URL=https://api-prod.andela.com
BASE_URL=http://wire.andela.com:8080

• Run the following command on the terminal to start the server: $ yarn start:dev

• NB: To access the Reported Incidents - Ensure you have an Admin role within the database - which you can setup after configuring the Wire-API here.

Running the tests

• Tests can can be run using one of the following commands

jest
npm run test:fend
jest --watch (to run test in  watch mode )

Built With

• Node Package Manager - The package manager used
• Webpack - A module bundler

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

• Anthony Nandaa
• Daniel Wangai
• Humphrey Musonye
• Ian Kingori
• James Kimani
• Mbarak Mbigo
• Rachael Njeri
• Robley Gori
• Akash Baga
• Peter Musonye

License

This project is licensed under the MIT License.

Acknowledgments

• Hat tip to Andela P&C Team Nairobi.
• Humprey Musonye for the designs.