Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 2.06 KB

README.md

File metadata and controls

49 lines (30 loc) · 2.06 KB

SimplQ

Build and Deploy Build and Deploy Gitter

SimplQ is a completely web based queue management solution that anyone can use to create instant virtual queues. Check us out on ProductHunt to know more and do upvote!

Development Environment Setup Instructions

These steps are to be followed when you are running the project for the first time.

  1. Install Node 12.x following instructions here.
  2. Clone this project.
  3. Change to simplq folder, install dependencies:
cd simplq
npm install

Starting Development Server

In the simplq folder, simply run:

npm start

We use Storybook.js for prototyping components. To start storybook and view existing components, run:

npm run storybook

Contributing

Feel free to fork and improve, and do send a pull request. Look for issues labelled with , PRs on these will be merged on priority.

There are a ton of features being planned. So if you are considering contributing to this repository, please first discuss the change you wish to make via the issue tracker.

This readme file details the file structure and tools used. Please go through it first. This is the design we've implemented and here, the assets (icons, images) we're using are available for download. The website is live here.

Implementation Roadmap: #207

Deploy

Changes to master are automatically deployed to dev.simplq.me/. Periodically, we inspect dev and promote it to simplq.me.