atlp-rwanda/atlp-devpulse-fn

# atlp-devpulse-fn

[![Maintainability](https://api.codeclimate.com/v1/badges/2c2cd9c0f847fcbba7a9/maintainability)](https://codeclimate.com/github/atlp-rwanda/atlp-devpulse-fn/maintainability)


## Introduction

Pulse is a platform designed to handle ratings for the companies in the **Ed-tech** industries with the its first paying customer being **Andela**. It is currently under development using modern web technologies that prioritize speed and security. This repo holds the codebase for the frontend part of the platform which uses **Reactjs** javascript framework for build modern UIs.

## Hosted version

- [Staging Application on Heroku]()

## How to run

To run this project on your local machine make sure that all the following are checked

- [ ] Nodejs installed on your computer ([MacOS](https://nodejs.org/en/download/), [Windows](https://nodejs.org/en/download/), [Linux](https://nodejs.org/en/download/))
- [ ] Git installed on your computer

Use the following commands to get started with the project

```js
git clone https://github.com/atlp-rwanda/atlp-devpulse-fn.git
cd atlp-devpulse-fn
npm install
npm run dev


### Other scripts and their usages

- `npm run lint` is used to format and check for linting errors files
- `npm run coverage` is used to run tests and generate coverage reports
- `npm run build` is used to build the production ready version of the projects. 
Used during deployment

## Technologies

To successfully navigate the codebase of the project, you will need undertanding 
of the following technologies that are being used to develop this application:

- Reactjs
- Typescript
- Tailwindcss