Streetcode

This is a front-end part of our Streetcode project. Back-end part: https://github.com/ita-social-projects/StreetCode.git.

---

Table of Contents

• Streetcode
  • Table of Contents
  • Installation
    • Required to install
    • Clone
    • Setup
      • Prerequisites
      • Installation Steps
    • How to run local
  • Usage
    • How to run tests
  • Documentation
  • Contributing
    • Gitflow
      • Step 1
      • Step 2
      • Step 3
      • Step 4
      • Step 5
      • Step 6
      • Step 7
      • Step 8
      • Step 9
    • Hotfixes
      • Step 1
      • Step 2
    • Issue flow
  • Team
  • FAQ
  • Support
  • About Us
  • License

---

Installation

First of all, make sure you have installed dependencies below and back-end part of project from: https://github.com/ita-social-projects/StreetCode.git.

Required to install

• NodeJS (16.0.0) or higher
• npm (7.10.0) or higher
• npx (10.2.2) or higher

Clone

Clone this repo to your local machine using:

git clone https://github.com/ita-social-projects/StreetCode_Client.git

Setup

To setup this project use this command in project folder:

npm install

To facilitate the usage of Workbox in our project, we have a few setup steps. Follow these instructions carefully:

Prerequisites

Before proceeding, ensure you have Chocolatey installed on your system.

Installation Steps

1. Install mkcert by running the following command from PowerShell (administrative):

   choco install mkcert
   

2. Create a cert folder in the root directory of cloned project.
3. Navigate to the cert folder in your console.
4. Run the following commands to generate SSL certificates:

mkcert -install

mkcert localhost 127.0.0.1

5. In webpack.dev.js file update DevServer section according to comment left there.

How to run local

To start project locally, write following command:

npm start

Open your browser and enter http://localhost:3000 url. If you had this page already opened, just reload it.

---

Usage

How to run tests

---

Documentation

Learn more about our documentation here.

---

Contributing

Gitflow

Gitflow is a lightweight, branch-based workflow.

Gitflow is an alternative Git branching model that involves the use of feature branches and multiple primary branches.

Step 1

• First step is checkout to develop branch and pull the recent changes.

Step 2

• 🍴 Fork this repo from develop branch and name it! A short, descriptive branch name enables your collaborators to see ongoing work at a glance. For example, increase-test-timeout or add-code-of-conduct.

Step 3

• 🔨 On your branch, make ANY reasonable & desired changes to the repository.

Step 4

• 📈 Commit and push your changes to your branch. Give each commit a descriptive message to help you and future contributors understand what changes the commit contains. For example, fix typo or increase rate limit. Note: you don't need to commit every line of your code in separate commits.

Step 5

• Before creating pull request you need to check the develop branch state! To avoid conflicts, you should merge develop branch to your local branch! And resolve your local conflicts. Mini manual: checkout to your local branch and write in console git merge develop.

Step 6

• 🔃 Create a new pull request using this link.

Step 7

• 🙋 Assign reviewers! Reviewers should leave questions, comments, and suggestions. After receiving comments, improve the code. Get Approved status on the request and be satisfied with it!

Step 8

• 🎉 After 3 approved reviews, merge your pull request with develop branch! Also, it is important to wait for your scrum master to approve your changes. If there are some conflicts, resolve them, again.

Step 9

• ✂️ Delete redundant branch. Done!

Hotfixes

Oops, some fixed needs to be done immediately? Use this guide for Hotfixes!

Some fixes will be needed due to the nature of Gitflow. You would have to do a 'hotfix' or something outside of the normal process, but it's simply part of our normal process.

Step 1

• 🔥 To implement an urgent change, a Hotfix branch is created off the develop branch to test and implement the fix.

Step 2

• 💃 Once it’s complete, the Hotfix is merged with the develop branch.

Issue flow

Find issues to work on here.

---

Team

Project manager

Tech expert

Business analyst

Dev team

---

FAQ

• Project falls after npm start command?
  • Try to install exactly the same version of NodeJS specified in the requirements (16.0.0)

---

Support

Reach out to us at one of the following places!

• Telegram at Iryna Zavushchak

---

About Us

Visit our site, we will be happy for everyone!

---

License

• MIT license
• Copyright 2022 © SoftServe IT Academy.