Skip to content

atlp-rwanda/atlp-pulse-fn

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CI Coverage Status

Dev-Pulse

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

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, Windows, Linux)
  • Git installed on your computer

Use the following commands to get started with the project

git clone https://github.com/atlp-rwanda/atlp-pulse-fn
cd atlp-pulse-fn
npm install
npm run dev
open http://localhost:3000

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 a minified production-ready version of the project.

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

Links: