FOOG

All rights reserved - a clause indicating that the copyrights belong to the entity informing about it. It is forbidden to change, copy or use the work in any way without the consent of the author.

Table of Contents

• Download
• Installation Requirements
• Environment Variables
• GIT
• Team
• Support

Download

   git clone https://github.com/Bartek-Figat/FOG.git

Installation

Tech Stack

• Client: React, Redux Toolkit, TailwindCSS

• Server: Node, Express

• DB: Mongodb driver

• Node: v14.17.6

Install with npm. In the project directory, you can run:

  npm install 
  npm run server

Install with npm. In the project directory client, you can run:

  npm install 
  npm start

Environment

To run this project, you will need to add the following environment variables to your .env file

   dbURI=mongodb://localhost:27017

   with Docker
   dbURI=mongodb://mongo:27017

   clientID=

   clientSecret=

   callbackURL=http://localhost:8080/auth/github/callback

   origin=http://localhost:3000/

   secret=secret

GIT

• Checkout a new branch in your repo, using the key at the beginning of the branch name. For example:

   git checkout -b FE#1

• When committing changes to your branch, use the key at the beginning of your commit message to link those commits to the development panel in your TRELLO. For example:

   git commit -m  "feat(FE#1): some message"

• Branching and merging For example:

  git checkout master

  git merge FE#1

• Commits types For example:

  git commit -m  "feat(FE#1): some message"

  git commit -m  "fix(FE#1): some message"

  git commit -m  "refactor(FE#1): some message"

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Bartłomiej Sopecki 💻

Bartosz Zagrodzki 💻

Serhii 💻

Bartek-Figat: Founder 💻

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

Support

For support. You can become a contributor.