README.md

Table of Contents

• Download
• Installation
• Docker compose
• Modules
• API Documentation
• Contributing
• Application demo

Buy Me Coffee

Coffee

Download

   https://github.com/Bartek-Figat/---BBARDS---.git

Installation

Use the following script to install modules in the front-end and back-end directory

  yarn install

To run the project, in the root directory use.

The command will start the front-end and back-end

  yarn start

Docker

If you want to code using Docker, create .env file in root directory:

  MONGO_INITDB_ROOT_USERNAME=developer
  MONGO_INITDB_ROOT_PASSWORD=password
  MONGO_INITDB_DATABASE=bbardslocal
  dbDEV=mongodb://${MONGO_INITDB_ROOT_USERNAME}:${MONGO_INITDB_ROOT_PASSWORD}@database/${MONGO_INITDB_DATABASE}?retryWrites=true&w=majority&authSource=admin

Then run below in the root directory

  docker compose up

Docker will bind ports:

3000 - Frontend

8080 - Backend

27017 - MongoDb

If you want to use other ports, open and modify the file docker-compose.yml

You can also run specific services:

docker compose up backend - will run backend service and mongodb

docker compose up frontend - will run frontend service

Modules

Modules installation

  yarn workspace <workspace_name> <command>

Example:

  yarn workspace @bbards-ts/front-end add react react-dom --dev

  yarn workspace @bbards-ts/back-end add cors

If you want to remove a package:

  yarn workspace web-project remove some-package

API

Swaggier API

Open http://localhost:8080/api-docs/ in the browser.

Contributing

Look at our CONTRIBUTING.md file to learn how to get started with gitflow.

Contributors ✨

Thanks go to these wonderful people (emoji key):

adrianixGit 📖	Bartlomiej Komendarczuk 📖	jsgostkowski 📖	kuprelweronika 📖	masterHAWK99 📖	Aleksander Skorek 📖
Add your contributions

This project follows the all-contributors specification. Contributions of any kind are welcome!