WIRE - Workspace Incident Reporting platform
To get this project up and running locally proceed as follows:
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.
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
-
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/hostswhich opens your /etc/hosts for editing using vim. To edit it, pressikey to get into insert mode and put these127.0.0.1 wire.andela.comafter the last line. Save changeswqafter pressing the escapeesckey. -
You will need to add the following to your
.envfile:
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
Adminrole within the database - which you can setup after configuring the Wire-API here.
- Tests can can be run using one of the following commands
jest
npm run test:fend
jest --watch (to run test in watch mode )
- Node Package Manager - The package manager used
- Webpack - A module bundler
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
- Anthony Nandaa
- Daniel Wangai
- Humphrey Musonye
- Ian Kingori
- James Kimani
- Mbarak Mbigo
- Rachael Njeri
- Robley Gori
- Akash Baga
- Peter Musonye
This project is licensed under the MIT License.
- Hat tip to Andela P&C Team Nairobi.
- Humprey Musonye for the designs.