README.md

🗒️ Scrumboard

The simplest task tracking tool for dev teams.

⚙️ Technologies used

• Next.js
• Socket.io
• React DnD
• MobX
• Sequelize

👩‍💻 Development

Start local DB:

docker run --rm --name postgres -e POSTGRES_PASSWORD=scrumboard -e POSTGRES_USER=scrumboard -p 5432:5432 -d postgres

Install dependencies:

yarn install

Setup the environment variales for dev by copying the .env.example file:

cp .env.example .env.local

Start development server:

yarn run dev

Now the app should be available on localhost:3000. To create the database schema call localhost:3000/api once.

Dev tools used:

• Typescript
• Linting with ESLint
• Formatting with Prettier
• Linting, typechecking and formatting on by default using husky for commit hooks
• Testing with Jest and react-testing-library

🏃‍♀️Run on production

Environment variales:

• NODE_ENV: Run Next.js in production mode if set to production. (Recommended)

• POSTGRES_URL: A connection string to a PostgresSQL database. (Required)

  Example: postgres://scrumboard:scrumboard@localhost:5432/postgres

• BASIC_AUTH: Secure all endpoints of the application using Basic auth. (Optional)

  Example: user:password

Install dependencies and build the project:

yarn install
yarn build

Run build on a server:

yarn start

🧩 Contributing

Thanks for your interest in Scrumboard! You are very welcome to contribute. Just follow the development guide and open a PR. Also, reporting and upvoting issues is highly appreciated.

🎉 Features/Todo

• Markdown support
• Manage user colors
• Delete a board
• Keyboard shortcuts