https://github.com/rubyforgood/kiwanis-ctc
A fundraising app for Kiwanis Arlington
https://github.com/rubyforgood/kiwanis-ctc
Last synced: about 1 year ago
JSON representation
A fundraising app for Kiwanis Arlington
- Host: GitHub
- URL: https://github.com/rubyforgood/kiwanis-ctc
- Owner: rubyforgood
- License: mit
- Created: 2022-04-03T01:42:01.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-05-05T01:05:58.000Z (about 1 year ago)
- Last Synced: 2025-05-05T02:22:20.147Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 16.8 MB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
Table of Contents
## 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](https://code.visualstudio.com/download) as it has helpful extensions as suggested below. Also, if on Windows, please ensure you have a command line program like [Git Bash Terminal](https://git-scm.com/downloads).
Some helpful extensions on VS Code:
- [Auto Close Tag](https://marketplace.visualstudio.com/items?itemName=formulahendry.auto-close-tag)
- [Auto Rename Tag](https://marketplace.visualstudio.com/items?itemName=formulahendry.auto-rename-tag)
- [HTML CSS Support](https://marketplace.visualstudio.com/items?itemName=ecmel.vscode-html-css)
- [JavaScript and TypeScript Nightly](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-typescript-next)
- [Typescript React code snippets](https://marketplace.visualstudio.com/items?itemName=infeng.vscode-react-typescript)
- [ES7+ React/Redux/React-Native snippets](https://marketplace.visualstudio.com/items?itemName=dsznajder.es7-react-js-snippets)
- [Live Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer)
- [Live Share](https://marketplace.visualstudio.com/items?itemName=MS-vsliveshare.vsliveshare)
### Prerequisites
Start by checking the version of Node installed on your device by running the following command:
```bash
npm -v
```
If the npm command is not recognized, please install the latest version of [Node.js](https://nodejs.org/en/download/).
### 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:
```bash
npm i
```
2. To start the local server, please run this command:
```bash
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:
```bash
npx eslint --fix .
```
## React Style Guide
* [This style guide](https://css-tricks.com/react-code-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](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716) 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