Vision

Create a community of like minded authors to foster inspiration and innovation by leveraging the modern web.

Badges

Build Status Maintainability Coverage Status

Deployment

Link to application host on heroku

Technology Stack

  • React
  • SCSS
  • Redux
  • Webpack
  • Jest
  • Enzyme

Installation

  1. Install Node JS.
  2. To clone, run git clone https://github.com/andela/ah-the-jedi-frontend.git
  3. cd into the root of the project directory.
  4. Run npm install on the terminal to install dependecies.
  5. Setup local development server.
  6. To start the application run npm run start:dev

Important note:

If you intend to contribute to this project, you need to install eslint and ensure linting is working in your editor.

Testing

Unit tests -

Run npm run test on the terminal while within the project root directory. Unit testing is achieved through the use of jest package. jest is used to test javascript code in React applications.

Support or Contribution

For any suggestions or contributions please do not hesistate to contact the owners of this repository. Contributions to this project are welcomed by all, If you need to contribute, follow the steps below

  • Fork the repository
  • Follow Installation and Setup as explained earlier
  • Create a branch off develop for the feature you wish to add
  • Make neccessary changes, commit and raise a pull request against develop, conventions can be found on the wiki page. Note when making contributions, please endevour to follow the Airbnb javascript style guide. Also make sure to follow the Engineering playbook for conventions.

Dev notice:

Package installation:

Use npm to install packages: npm install

Running the application

Visit our Heroku link to try out this product: link In case of any errors ask the DevOps Engineer in the team