erickarugu / complimentr

An online platform that enables colleagues and teammates to write each other anonymous "digital notes" to keep one another motivated. Inspired by physical sticky notes.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Complimentr

An online platform that enables colleagues and teammates to write each other anonymous "digital notes" to keep one another motivated. We all need some to regularly compliment us to keep us psyched up. In the modern days most people spend much of their time on screens and this is the source of motivation for this project. Inspired by physical sticky notes.

Technologies

Clone to run/edit/use locally

The provided source code is free to clone and use locally.Run the following command in your terminal to clone this repo:

git clone https://github.com/erickarugu32/complimentr.git

Alternatively you can download the zip folder and extract in your local machine.

Install Dependencies

After cloning or extracting the project folder in your machine, you will need to install dependencies for the app to run as expected. This is very easy thanks to the work of all developers around the globe. All you need to do is run the following command in your termina. Note: Only run this command after you have navigated into the project's folder in your terminal.

npm install

Ensure you have NodeJs and NPM installed in your amazing machine before running this command otherwise you will get some weird errors.

Development server

Run the following command in your terminal after all the dependencies are installed for a dev server.

ng serve

Then Navigate to http://localhost:4200/ to see it live. The app will automatically reload if you change any of the source files.

Build for Deployment

Run the following command in your terminal to build the project for deployment. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

ng build

Running unit tests

Run the following command in your terminal to execute the unit tests via Karma.

ng test

Running end-to-end tests

Run the following command in your terminal to execute the end-to-end tests via Protractor.

ng e2e

Live

The project is live here:

About

An online platform that enables colleagues and teammates to write each other anonymous "digital notes" to keep one another motivated. Inspired by physical sticky notes.


Languages

Language:TypeScript 60.3%Language:HTML 36.3%Language:JavaScript 3.1%Language:CSS 0.2%