Skip to content

Commit

Permalink
ch(README): create client README file
Browse files Browse the repository at this point in the history
- Add Installation and run commands
- Add Description
- Add  Tests setup and execution process
[Start #169258573]
  • Loading branch information
victkarangwa committed Dec 27, 2019
1 parent e27b3f9 commit 62b918f
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,47 @@
[![CircleCI](https://circleci.com/gh/andela/team-odd-bn-frontend/tree/develop.svg?style=svg)](https://circleci.com/gh/andela/team-odd-bn-frontend/tree/develop)

# Barefoot Nomad
## Vision
##### Making company travel and accomodation easy and convinient.

## Description
Make company global travel and accommodation easy and convenient for the strong workforce of savvy members of staff, by leveraging the modern web.

### Dependencies
- Environment : [Nodejs](https://nodejs.org/)
- Package Manager : [NPM](https://www.npmjs.com)
- Compiler : [Babel](https://babeljs.io/)
- Bundler : [Webpack](https://webpack.js.org/)
- CSS Pre processor : [Sass](https://sass-lang.com)
- Client Side : [Reactjs](https://reactjs.org),[Redux](https://redux.js.org)

### Installation

##### A. Clone the project
1. From your computer, open terminal
2. Run `clone https://github.com/andela/team-odd-bn-frontend.git` OR [Download](https://github.com/andela/team-odd-bn-frontend/archive/develop.zip) the project

##### B. Setting up the environment
1. Create a file and name it `.env` in root directory
2. Find a file named `.env.example`
3. Copy & paste all environmental variables from `.env.example` to `.env`
4. Provide values to all environmental variables in `.env` file

### Run commands
Open terminal from your computer
1. Run `npm install` to install all dependencies
2. Run `npm test` to test automatically if the is functioning properly as expected
3. To start the app, run `npm start`. You will see the following details:

![running server](
https://res.cloudinary.com/victorkarangwa4/image/upload/c_scale,w_361/v1577445288/icons/Screen_Shot_2019-12-27_at_13.02.39_adcfoj.png)

4. Copy & paste any of the link to your browser
5. You should now see the application running in your browser

### Raising an issue
Click [here](https://github.com/andela/team-odd-bn-frontend/issues/new) to create an issue about this app

# Author
Team-odd

0 comments on commit 62b918f

Please sign in to comment.