README.md

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. React Style Guide
4. Commit Style Guide

About The Project

This application enables the Arlington chapter of Kiwanis International to easily track orders for their annual blueberry fundraising drive.

Built With

This section entails the technologies we have used thus far in our project.

Getting Started

We recommend downloading Visual Studio Code as it has helpful extensions as suggested below. Also, if on Windows, please ensure you have a command line program like Git Bash Terminal.

Some helpful extensions on VS Code:

• Auto Close Tag
• Auto Rename Tag
• HTML CSS Support
• JavaScript and TypeScript Nightly
• Typescript React code snippets
• ES7+ React/Redux/React-Native snippets
• Live Server
• Live Share

Prerequisites

Start by checking the version of Node installed on your device by running the following command:

npm -v

If the npm command is not recognized, please install the latest version of Node.js.

Installation

1. After you have cloned the git repository and ensured npm and node.js is installed, to install all necessary node modules, please type:

npm i

2. To start the local server, please run this command:

npm start

Note:

After running this command, the following link should open in your default browser:

http://localhost:3000

If you have issues with the linter, please run:

npx eslint --fix .

React Style Guide

• This style guide provides a good baseline for writing readable React code. Please ensure that your code follows these conventions.
• Prefer the use of function components over class components as they also improve readability

Commit Style Guide

• Follow semantic commit messages when writing your commits
• Branch names should be in the format jdoe/name-of-feature where jdoe is in the format first initial, last name. Use dashes (-) to separate words