Briefly Planning Poker

description about briefly planning poker web site.. demo..

Badge

coverage, tests, ci/cd, prs, issues, license

Documentation

documentation link, getting started link etc

Roadmap

checklist: features.. new features

⚙️Requirements

• Node.js*
• Yarn
• Docker
• Docker Compose
• PgAdmin**

* Check current Node version at package.json

** The project uses PostgreSQL, PgAdmin is a usefull recommended tool to check database structure, status and tables.

🛠Development

• To run all application (front-end, back-end and database): docker-compose up front

  This command will create a new postgreSQL database using .env variables to set up password, username and database name. Also runs all migrations and seeds scripts (./packages/store/db/migrations), and finally starts api and front-end.

• To run only back-end: docker-compose up api

  This command will create a new postgreSQL database using .env variables to set up password, username and database name. Also runs all migrations and seeds scripts (./packages/store/db/migrations), and finally starts api.

• To run only database: docker-compose up db

  This command will create a new postgreSQL database using .env variables to set up password, username and database name.

* Make sure all requeriments are installed

* All environment variables must be filled in .env at root folder

💻Tech Stack

• Vue.js
• Sass
• Typescript
• Express.js
• Knex
• PostgreSQL
• Jest

🤝Contribute

Contribution guide can be access here!

Contributors

Aline Conquista

Lucca Jacomassi