/stop-analyzing-embed

Stop Analyzing interaction component to be embedded in your website

Primary LanguageCSSMIT LicenseMIT

Stop Analyzing Embed

This is a Poppins project first-timers-only

Stop Analyzing is a tool that uses Tinder like interaction to help your customers make up their mind when choosing something that has lot of options, like a product of an e-commerce. Check this repo for more details and this issue explains how this idea was born. Stop Analyzing Embed is a web component to be embedded on client websites.

This project was made for first-time contributors and open source beginners

This project follows the Poppins manifesto guidelines as part of it's community principles and policies, focusing all the decisions and interactions on providing open source beginners mentorship with real and relevant experiences, respecting each learning pace, background experience, academic formation, questions, suggestions, doubts and opinion.

Contribute now!

So, let's start contributing! Open an issue asking for a task to be done by you. A mentor/maintainer will come and provide a technical overview of the project and what are the possibles ways of contributing to the project. You will discuss the options and a suitable issue will be assigned or created to you.

That's it. Just make yourself at home and good luck!

Getting Started

To build and run stop-analyzing-embed locally, just follow the instructions bellow. You can either using docker or run it directly using NPM run commands. On both ways, web server will show the hostname on the console, something like this:

stop-analyzing-embed | Listening on http://738e062f602e:8000, http://127.0.0.1:8000, http://192.168.124.2:8000

Using Docker

To run with docker-compose:

docker-compose up

If you prefer work on Dockerfile directly:

docker build . --tag stop-analyzing-embed:latest

Using a Development Environment

Make sure to install all the dependencies:

$ cd app
$ npm install

Run de application:

npm run start

Important: make sure you have NPM installed in your machine.

Thats it! We are ready to go!

Awesome list of other Poppins projects for you to go

Awesome